Added more help classes, moved files to public

Author: juskek

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.1+2
+
+* Added a lot more help classes 
+
 ## 0.0.1+1
 
 * Exposed Help classes

README.md

@@ -9,7 +9,7 @@ Flutter dev utils to make your life easier
 * CallerLogger
   * Built off logger package with functionality to print caller, ignore certain callers, and filter printed logs by caller type
 * Help
-  * HelpFoo classes which can be used for inline code help.
+  * Stop clicking those purple stackoverflow links! HelpFoo classes can be used for inline code help.
 
   ![Alt Text](https://github.com/Kek-Tech/flutter_dev_utils/blob/main/assets/HelpClass.gif)
 

lib/flutter_dev_utils.dart

@@ -1,8 +1,5 @@
 library flutter_dev_utils;
 
-export 'package:flutter_dev_utils/src/inline_help/help_error.dart';
-export 'package:flutter_dev_utils/src/inline_help/help_singleton.dart';
-
 export 'package:flutter_dev_utils/src/try_handler/sync_try_handler.dart';
 export 'package:flutter_dev_utils/src/try_handler/async_try_handler.dart';
 export 'package:flutter_dev_utils/src/caller_logger/caller_logger.dart';

lib/inline_help/classes/help_abstract_class.dart

@@ -0,0 +1,84 @@
+/// TODO
+/// # Help with Abstract classes
+///
+/// * Abstract classes cannot be instantiated.
+///
+/// ## Use cases
+///
+/// ### Extending an abstract class to override its function
+/// ```
+/// abstract class AbstractClass {
+///   void function();
+/// }
+///
+/// class Example extends AbstractClass {
+///   @override
+///   void function() => print('hi');
+/// }
+/// ```
+///
+/// ### Extending an abstract class to inherit its instance variable
+///
+/// * Instance variable has to be declared on instantiation of subclass.
+///
+/// ```
+/// abstract class AbstractClass {
+///   final String instanceVar;
+///   AbstractClass(this.instanceVar);
+/// }
+///
+/// class Example extends AbstractClass {
+///   Example(super.instanceVar);
+/// }
+/// ```
+///
+/// ### Implementing an abstract class to override its instance variable
+/// ```
+/// abstract class AbstractClass {
+///   final String instanceVar;
+///   AbstractClass(this.instanceVar);
+/// }
+///
+/// class Example implements AbstractClass {
+///   @override
+///   final String instanceVar = 'const';
+///   Example();
+/// }
+/// ```
+/// ### Mixing in an abstract class to inherit its instance variable
+///
+/// * Declaration of instance variable not necessary on instantiation of subclass
+///
+/// ```
+/// abstract class AbstractClass {
+///   String? instanceVar;
+/// }
+///
+/// class Example with AbstractClass {
+///   Example();
+/// }
+/// ```
+///
+/// ### Implementing an abstract class to inherit its members (interface)
+///
+/// * An interface is a superclass that acts as a blueprint for a subclass
+/// * Implementing an abstract class forces the subclass to override all members of the super
+/// * See HelpInterface for more details on `implements`
+///
+/// ```
+/// abstract class AbstractClass {
+///   String? instanceVariable;
+///
+///   void _function();
+/// }
+///
+/// class Example implements AbstractClass {
+///   @override
+///   void _function() => null;
+///
+///   @override
+///   String? instanceVariable = '';
+/// }
+/// ```
+
+abstract class HelpAbstractClass {}

lib/inline_help/classes/help_annotations.dart

@@ -0,0 +1,2 @@
+/// TODO
+abstract class HelpInterface {}

lib/inline_help/classes/help_interface.dart

@@ -0,0 +1,5 @@
+/// Help with important concepts in Dart
+///
+///
+
+class HelpDart {}

lib/src/inline_help/help_singleton.dart …/inline_help/classes/help_singleton.dartlib/src/inline_help/help_singleton.dart renamed to lib/inline_help/classes/help_singleton.dart lib/src/inline_help/help_singleton.dart renamed to lib/inline_help/classes/help_singleton.dart

@@ -0,0 +1,58 @@
+/// # Help with Dart syntax
+///
+/// ## Multiple if
+/// ```
+///   (() {
+///     /// your code here
+///   }())
+/// ```
+///
+/// ## Spread Operator
+/// - Can be used to return multiple widgets
+/// ```
+/// if (Responsive.isDesktop()) ...[
+///     Text('Desktop')
+///     Text('Mode')
+///   ]
+/// ```
+///
+/// ## Cascade Notation
+///
+/// Prevents repeating target for several call methods on same object.
+///
+/// ```
+/// List list = [];
+/// list.add(color1);
+/// list.add(color2);
+///
+/// list
+///   ..add(color1)
+///   ..add(color2);
+/// ```
+///
+/// ## Arrow
+/// ```
+///     => expression,
+///     /// is equivalent to
+///     {return expression;},
+/// ```
+///
+/// ## Closure/Inline Functions
+/// ```
+///     () => expression
+///
+///     /// is equivalent to
+///     function () {
+///         return expression
+///     }
+/// ```
+///
+/// ## Anonymous Multiline Function
+/// ```
+///   () {expression}
+///   /// is equivalent to
+///   function () {
+///       return expression
+///   }
+/// ```
+class HelpDartSyntax {}

lib/inline_help/dart/help_dart.dart

@@ -0,0 +1,15 @@
+/// # Inheritance
+///
+/// ## extends
+///
+/// - making all properties, variables, functions of superclass available to subclass
+///
+/// ## implements
+///
+/// - making type of superclass available to subclass
+/// - all functions must be implemented/overridden
+///
+/// ## with (mixin)
+///
+/// - making properties, variables, functions of a different class available to a subclass
+class HelpInheritance {}