Merge pull request #56 from aws4embeddedlinux/update-typedoc-setup

Update typedoc setup

lib/build-image-data.ts

@@ -9,18 +9,18 @@ import * as kms from 'aws-cdk-lib/aws-kms';
 import { RemovalPolicy } from 'aws-cdk-lib';
 
 /**
- * Select options for the BuildImageDataStack.
+ * Select options for the {@link BuildImageDataStack}.
  */
 export interface BuildImageDataProps extends cdk.StackProps {
   /** The bucket name for image build sources. This must be globally unique. */
   readonly bucketName: string;
 }
 
 /**
- * Input (Source) data for our Build Image Pipeline.
+ * Input (Source) data for our {@link BuildImagePipelineStack}.
  */
 export class BuildImageDataStack extends cdk.Stack {
-  /** The bucket where source for Build Images are. */
+  /** The bucket which will be consumed by the {@link BuildImagePipelineStack}. */
   public readonly bucket: s3.IBucket;
 
   constructor(scope: Construct, id: string, props: BuildImageDataProps) {

lib/build-image-pipeline.ts

@@ -20,12 +20,12 @@ export enum ImageKind {
 }
 
 /**
- * Select options for the BuildImagePipelineStack.
+ * Select options for the {@link BuildImagePipelineStack}.
  */
 export interface BuildImagePipelineProps extends cdk.StackProps {
   /** The Image type to create. */
   readonly imageKind: ImageKind;
-  /** The data bucket from the BuildImageDataStack */
+  /** The data bucket from the {@link BuildImageDataStack} */
   readonly dataBucket: s3.IBucket;
   /** The ECR Repository to push to. */
   readonly repository: IRepository;
@@ -34,6 +34,8 @@ export interface BuildImagePipelineProps extends cdk.StackProps {
 /**
  * The pipeline for building the CodeBuild Image used in other pipelines. This
  * will produce an image for an OS based on verified Yocto hosts.
+ *
+ * For configuration options see {@link BuildImagePipelineProps}.
  */
 export class BuildImagePipelineStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props: BuildImagePipelineProps) {

lib/build-image-repo.ts

@@ -4,6 +4,8 @@ import * as ecr from 'aws-cdk-lib/aws-ecr';
 
 /**
  * The ECR Repository to store build host images.
+ *
+ * This is the output of the {@link BuildImagePipelineStack}
  */
 export class BuildImageRepoStack extends cdk.Stack {
   /** The respository to put the build host container in. */

lib/constructs/source-repo.ts

@@ -31,6 +31,9 @@ export interface SourceRepoProps extends cdk.StackProps {
 
 /**
  * The repository for the Source Stage of the pipeline.
+ *
+ * The initial contents of this repository are seeded by the assets contained
+ * in the `source-repo/` folder of this library.
  */
 export class SourceRepo extends Construct {
   /** The CodeCommit Repo itself. */

lib/embedded-linux-pipeline.ts

@@ -51,7 +51,9 @@ export interface EmbeddedLinuxPipelineProps extends cdk.StackProps {
 }
 
 /**
- * The stack demonstrating how to build a pipeline for meta-aws-demos
+ * The stack for creating a build pipeline.
+ *
+ * See {@link EmbeddedLinuxPipelineProps} for configration options.
  */
 export class EmbeddedLinuxPipelineStack extends cdk.Stack {
   constructor(scope: Construct, id: string, props: EmbeddedLinuxPipelineProps) {

lib/network.ts

@@ -5,6 +5,9 @@ import { LogGroup, RetentionDays } from 'aws-cdk-lib/aws-logs';
 
 /**
  * The network resources to run the pipeline in.
+ *
+ * This stack is provided for when users do not have an existing VPC with
+ * private and public subnets for the pipeline.
  */
 export class PipelineNetworkStack extends cdk.Stack {
   /** The VPC for the pipeline to reside in. */

lib/vm-import-bucket.ts

@@ -11,7 +11,7 @@ export interface VMImportBucketProps extends s3.BucketProps {
 }
 
 /**
- * ...
+ * An S3 Bucket with roles for the VM Import/Export service.
  */
 export class VMImportBucket extends s3.Bucket {
   public readonly roleName: string;

package.json

@@ -13,7 +13,7 @@
     "test": "jest",
     "update-snapshot": "jest -u",
     "cdk": "cdk",
-    "doc": "typedoc",
+    "doc": "typedoc --sort source-order --readme README.md",
     "format": "eslint '**/*.{js,ts,json}' --quiet --fix",
     "check": "eslint '**/*.{js,ts,json}'",
     "prepare": "npm run build"