Add remaining documentation

Author: JordonPhillips

smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocGenerationContext.java

@@ -28,6 +28,15 @@ public final class DocGenerationContext implements CodegenContext<DocSettings, D
     private final WriterDelegator<DocWriter> writerDelegator;
     private final List<DocIntegration> docIntegrations;
 
+    /**
+     * Constructor.
+     *
+     * @param model The source model to generate for.
+     * @param docSettings Settings to customize generation.
+     * @param symbolProvider The symbol provider to use to turn shapes into symbols.
+     * @param fileManifest The file manifest to write to.
+     * @param docIntegrations A list of integrations to apply during generation.
+     */
     public DocGenerationContext(
             Model model,
             DocSettings docSettings,

smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/DocSymbolProvider.java

@@ -25,7 +25,7 @@
  * <p>These symbols contain many important pieces of metadata. Particularly
  * important are:
  *
- * <p><ul>
+ * <ul>
  *     <li>{@code name}: The name of the symbol will be used as the title for its
  *     definition section. For services, this defaults to the value of the
  *     {@code title} trait. For other shapes, it defaults to the shape name including
@@ -86,6 +86,12 @@ public final class DocSymbolProvider extends ShapeVisitor.Default<Symbol> implem
     private final DocSettings docSettings;
     private final ServiceShape serviceShape;
 
+    /**
+     * Constructor.
+     *
+     * @param model The model to provide symbols for.
+     * @param docSettings Settings used to customize symbol creation.
+     */
     public DocSymbolProvider(Model model, DocSettings docSettings) {
         this.model = model;
         this.docSettings = docSettings;
@@ -124,7 +130,7 @@ private String getDefinitionFile(ServiceShape serviceShape, Shape shape) {
         );
     }
 
-    public String getDefinitionFile(String filename) {
+    private String getDefinitionFile(String filename) {
         return "content/" + filename;
     }
 

smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/DocWriter.java

@@ -21,6 +21,11 @@ public abstract class DocWriter extends SymbolWriter<DocWriter, DocImportContain
 
     private int headingDepth = 0;
 
+    /**
+     * Constructor.
+     *
+     * @param importContainer The container to store any imports in.
+     */
     public DocWriter(DocImportContainer importContainer) {
         super(importContainer);
     }

smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/MarkdownWriter.java

@@ -8,14 +8,25 @@
 import software.amazon.smithy.codegen.core.SymbolWriter;
 import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.model.traits.DocumentationTrait;
+import software.amazon.smithy.utils.SmithyUnstableApi;
 import software.amazon.smithy.utils.StringUtils;
 
+/**
+ * Writes documentation in <a href="https://spec.commonmark.org">CommonMark</a> format.
+ */
+@SmithyUnstableApi
 public final class MarkdownWriter extends DocWriter {
 
+    /**
+     * Constructor.
+     */
     public MarkdownWriter() {
         super(new DocImportContainer());
     }
 
+    /**
+     * Factory to construct {@code MarkdownWriter}s.
+     */
     public static final class Factory implements SymbolWriter.Factory<DocWriter> {
         @Override
         public DocWriter apply(String s, String s1) {

smithy-docgen-core/src/test/java/software/amazon/smithy/docgen/core/SmithyDocPluginTest.java

@@ -1,16 +1,6 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
- *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
- *
- *  http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
  */
 
 package software.amazon.smithy.docgen.core;