Merge pull request #1355 from nextcloud/chore/neon_framework/file-lev…

…el-doc-ignores

packages/neon_framework/analysis_options.yaml

@@ -2,8 +2,6 @@ include: package:neon_lints/flutter.yaml
 
 linter:
   rules:
-    # should be enabled for release. https://github.com/nextcloud/neon/issues/692
-    public_member_api_docs: false
     # TODO: migrate package to new lint rules
     prefer_final_parameters: true
     avoid_final_parameters: false

packages/neon_framework/lib/src/bloc/result.dart

@@ -107,6 +107,7 @@ class Result<T> {
   /// Copies this Result in a loading state.
   Result<T> asLoading() => copyWith(isLoading: true);
 
+  /// Copies this Result and optionally replaces the [data], [error], [isLoading] and [isCached].
   Result<T> copyWith({
     final T? data,
     final Object? error,

packages/neon_framework/lib/src/blocs/timer.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'dart:async';
 import 'dart:ui';
 

packages/neon_framework/lib/src/pages/login_qr_code.dart

@@ -64,8 +64,10 @@ class _LoginQRcodePageState extends State<LoginQRcodePage> {
       );
 }
 
+/// Exception which is thrown when an invalid QR code is encountered.
 @immutable
 class InvalidQRcodeException extends NeonException {
+  /// Creates a new [InvalidQRcodeException].
   const InvalidQRcodeException();
 
   @override

packages/neon_framework/lib/src/settings/widgets/settings_category.dart

@@ -36,6 +36,7 @@ class SettingsCategory extends StatelessWidget {
   }
 }
 
+@internal
 class MaterialSettingsCategory extends StatelessWidget {
   const MaterialSettingsCategory({
     required this.children,

packages/neon_framework/lib/src/settings/widgets/settings_list.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:flutter/material.dart';
 import 'package:neon_framework/src/utils/adaptive.dart';
 import 'package:scrollable_positioned_list/scrollable_positioned_list.dart';

packages/neon_framework/lib/src/utils/confirmation_dialog.dart

@@ -2,6 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:neon_framework/l10n/localizations.dart';
 import 'package:neon_framework/src/theme/colors.dart';
 
+/// Shows a dialog asking the user to confirm the question posed in the [title].
 Future<bool> showConfirmationDialog(final BuildContext context, final String title) async =>
     await showDialog<bool>(
       context: context,

packages/neon_framework/lib/src/utils/findable.dart

@@ -6,6 +6,7 @@ abstract interface class Findable {
   String get id;
 }
 
+/// An extension to find [Findable]s in an iterable.
 extension FindExtension<T extends Findable> on Iterable<T> {
   /// Returns the first element matching [id] by [Findable.id].
   ///

packages/neon_framework/lib/src/utils/rename_dialog.dart

@@ -2,6 +2,9 @@ import 'package:flutter/material.dart';
 import 'package:neon_framework/src/utils/validators.dart';
 import 'package:neon_framework/src/widgets/dialog.dart';
 
+/// Shows a dialog asking the user to rename the thing stated in the [title].
+///
+/// [value] describes the current name of the thing before renaming.
 Future<String?> showRenameDialog({
   required final BuildContext context,
   required final String title,

packages/neon_framework/lib/src/utils/request_manager.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'dart:async';
 import 'dart:convert';
 

packages/neon_framework/lib/src/widgets/custom_background.dart

@@ -11,6 +11,7 @@ import 'package:neon_framework/src/widgets/options_collection_builder.dart';
 /// The background will be loaded from the server.
 /// It might be a single color or a full image.
 class NeonCustomBackground extends StatelessWidget {
+  /// Creates a new custom background.
   const NeonCustomBackground({
     required this.child,
     super.key,

packages/neon_framework/lib/src/widgets/drawer_destination.dart

@@ -2,9 +2,6 @@ import 'package:flutter/material.dart';
 import 'package:meta/meta.dart';
 import 'package:rxdart/subjects.dart';
 
-@internal
-typedef DestinationIconBuilder = Widget Function({double? size, Color color});
-
 @internal
 class NeonNavigationDestination {
   const NeonNavigationDestination({
@@ -15,7 +12,7 @@ class NeonNavigationDestination {
   });
 
   final String label;
-  final DestinationIconBuilder icon;
+  final Widget Function({double? size, Color color}) icon;
   final Widget? selectedIcon;
   final BehaviorSubject<int>? notificationCount;
 }

packages/neon_framework/lib/src/widgets/image.dart

@@ -127,6 +127,7 @@ class NeonCachedImage extends StatefulWidget {
     );
   }
 
+  /// The [CacheManager] instance.
   @visibleForTesting
   static DefaultCacheManager cacheManager = DefaultCacheManager();
 

packages/neon_framework/lib/src/widgets/list_view.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: public_member_api_docs
+
 import 'package:flutter/material.dart';
 import 'package:neon_framework/src/widgets/error.dart';
 import 'package:neon_framework/src/widgets/linear_progress_indicator.dart';