Improve documentation

src/main/kotlin/net/theevilreaper/dartpoet/DartFile.kt

@@ -63,7 +63,11 @@ class DartFile internal constructor(
         }
     }
 
-
+    /**
+     * Writes the content from a [DartFile] to the given [Appendable].
+     * @param out the [Appendable] where the content should be written
+     * @throws IOException if the content can't be written
+     */
     @Throws(IOException::class)
     fun write(out: Appendable) {
         val codeWriter = CodeWriter(
@@ -74,6 +78,11 @@ class DartFile internal constructor(
         codeWriter.close()
     }
 
+    /**
+     * Writes the content from a [DartFile] to the given [Path].
+     * @param path the path where the file should be written
+     * @throws IOException if the file can't be written
+     */
     @Throws(IOException::class)
     fun write(path: Path) {
         require(Files.notExists(path) || Files.isDirectory(path)) {
@@ -114,6 +123,9 @@ class DartFile internal constructor(
         return builder
     }
 
+    /**
+     * Creates a new instance of [DartFileBuilder] with the specified name.
+     */
     companion object {
 
         /**

src/main/kotlin/net/theevilreaper/dartpoet/property/PropertySpec.kt

@@ -5,6 +5,7 @@ import net.theevilreaper.dartpoet.annotation.AnnotationSpec
 import net.theevilreaper.dartpoet.code.CodeWriter
 import net.theevilreaper.dartpoet.code.writer.PropertyWriter
 import net.theevilreaper.dartpoet.code.buildCodeString
+import net.theevilreaper.dartpoet.property.consts.ConstantPropertyBuilder
 import net.theevilreaper.dartpoet.type.ClassName
 import net.theevilreaper.dartpoet.type.TypeName
 import net.theevilreaper.dartpoet.type.asTypeName
@@ -84,6 +85,9 @@ class PropertySpec(
         return builder
     }
 
+    /**
+     * The companion object contains some helper methods to create a new instance from the [PropertyBuilder].
+     */
     companion object {
 
         /**

src/main/kotlin/net/theevilreaper/dartpoet/type/ClassName.kt

@@ -7,6 +7,7 @@ import kotlin.reflect.KClass
 
 /**
  * A class representing a custom type named [ClassName].
+ * It can be used to model class names, interface names, typedef names, and enum names which are not built-in types.
  *
  * @param name the name of the [ClassName]
  * @param isNullable a flag indicating whether the [ClassName] can be null (default is false).

src/main/kotlin/net/theevilreaper/dartpoet/type/ParameterizedTypeName.kt

@@ -77,6 +77,9 @@ class ParameterizedTypeName internal constructor(
         return out
     }
 
+    /**
+     * Returns a copy of this [ParameterizedTypeName] with the provided type arguments.
+     */
     companion object {
 
         /**

src/main/kotlin/net/theevilreaper/dartpoet/type/TypeNames.kt

@@ -1,16 +1,27 @@
 package net.theevilreaper.dartpoet.type
 
+/**
+ * The file contains some common used [ClassName] instances which are used in the library.
+ * It contains only the primitive types which are supported by Dart.
+ * @since 1.0.0
+ */
+
+// Represents the boolean type in Dart
 @JvmField
 val BOOLEAN: ClassName = ClassName("bool")
 
+// Represents the integer type in Dart
 @JvmField
 val INTEGER: ClassName = ClassName("int")
 
+// Represents the double type in Dart
 @JvmField
 val DOUBLE: ClassName = ClassName("double")
 
+// Represents the string type in Dart
 @JvmField
 val STRING: ClassName = ClassName("String")
 
+// Represents the dynamic type in Dart
 @JvmField
 val DYNAMIC: ClassName = DynamicClassName()