Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
theEvilReaper committed Jan 13, 2024
1 parent 5999e28 commit dea9d8b
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import kotlin.reflect.KClass
* - @pragma
*
* Please note you can use the predefined annotations from the JDK or Kotlin but doesn't except that they work in Dart.
* @param builder the builder instance to retrieve the data from
* @author theEvilReaper
* @version 1.0.0
* @since
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import net.theevilreaper.dartpoet.type.TypeName
* With the AnnotationBuilder data can be set to an annotation.
* These are later read out during generation and converted into code accordingly.
* @author theEvilReaper
* @param typeName the name of the annotation
* @version 1.0.0
* @since
**/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import kotlin.reflect.KClass

/**
* The builder class allows the creation of an [FunctionBuilder] without any effort.
* @param name the name of the function
* @author 1.0.0
* @since 1.0.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import net.theevilreaper.dartpoet.util.toImmutableSet
/**
* The spec class contains all relevant information about a function in dart.
* A [FunctionWriter] instance read the data from it to write the data into the function structure from dart.
*
* @param builder the builder instance to retrieve the data from
* @author theEvilReaper
* @since 1.0.0
* @version 1.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import kotlin.reflect.KClass
* The builder is used to create a type definition with a specific name and optional type cast.
* After the construction the builder maps the data into a [TypeDefSpec] object.
*
* @property typeDefName the name of the type definition.
* @property typeCasts optional array of type-cast for the type definition.
* @param typeDefName the name of the type definition.
* @param typeCasts optional array of type-cast for the type definition.
*/
class TypeDefBuilder internal constructor(
val typeDefName: String,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import kotlin.reflect.KClass
/**
* The class models a typedef from dart into a structure which can be used to generate and organize such methods.
* For more details visit the documentation from dart
* @param builder the builder instance to retrieve the data from
* @see <a href="https://dart.dev/language/typedefs">Dart Typedefs</a>.
*/
class TypeDefSpec(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ import kotlin.reflect.KClass
*
* This class is typically used in code generation tasks to define and manipulate parameter specifications
* for generating source code.
* @param builder the builder instance to retrieve the data from
* @author theEvilReaper
* @since 1.0.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ import net.theevilreaper.dartpoet.type.TypeName

/**
* The builder is used to set all values that describe a property in Dart.
* @param name the name of the property
* @param type the type as [TypeName] of the property (can be nullable)
* @author theEvilReaper
* @version 1.0.0
* @since 1.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import kotlin.reflect.KClass
/**
* The property spec class contains all variables which are comes from the [PropertyBuilder].
* Some values are checked for certain conditions to avoid errors during the generation.
* @param builder the builder instance to retrieve the data from
* @author theEvilReaper
* @since 1.0.0
*/
Expand Down

0 comments on commit dea9d8b

Please sign in to comment.