docs: update code docs and styling #116

docs: update code docs and styling

src/index.ts

@@ -21,7 +21,7 @@ export * as parameters from './lib/Components/Parameters';
 export * as executors from './lib/Components/Executors';
 
 /**
- * Logical conditions for conditional components.
+ * Conditional statements for 2.1 config conditionals.
  */
 export * as logic from './lib/Components/Logic';
 
@@ -36,7 +36,7 @@ export * as types from './lib/Types';
 export * as workflow from './lib/Components/Workflow';
 
 /**
- * All imports pertaining to orbs
+ * All orb components.
  */
 export * as orb from './lib/Orb';
 

src/lib/Components/Logic/exports/Conditional.ts

@@ -2,8 +2,8 @@ import { When } from './When';
 
 /**
  Conditional logic interface.
- 
- https://circleci.com/docs/2.0/configuration-reference/#logic-statements
+ @see {@link https://circleci.com/docs/2.0/configuration-reference/#logic-statements}
+ {@label STATIC_2.1}
 */
 export interface Conditional {
  when?: When;

src/lib/Components/Logic/exports/conditions/And.ts

@@ -3,6 +3,10 @@ import { GenerableType } from '../../../../Config/exports/Mapping';
 import { AndConditionShape, ConditionOrValue } from '../../types';
 import { Condition } from '../Condition';
 
+/**
+ * True if all arguments are truthy.
+ * @see {@link https://circleci.com/docs/configuration-reference#logic-statements}
+ */
 export class And extends Condition {
  conditions: Condition[];
 

src/lib/Components/Logic/exports/conditions/Equal.ts

@@ -3,7 +3,8 @@ import { ConditionValue, EqualConditionShape } from '../../types';
 import { Condition } from '../Condition';
 
 /**
- * Compare two or more values.
+ * True if all arguments evaluate to equal values.
+ * @see {@link https://circleci.com/docs/configuration-reference#logic-statements}
  */
 export class Equal extends Condition {
  constructor(private values: ConditionValue[]) {

src/lib/Components/Logic/exports/conditions/Not.ts

@@ -3,6 +3,10 @@ import { GenerableType } from '../../../../Config/exports/Mapping';
 import { ConditionOrValue, NotConditionShape } from '../../types';
 import { Condition } from '../Condition';
 
+/**
+ * True the argument is not truthy.
+ * @see {@link https://circleci.com/docs/configuration-reference#logic-statements}
+ */
 export class Not extends Condition {
  condition: Condition;
 

src/lib/Components/Logic/exports/conditions/Or.ts

@@ -3,6 +3,10 @@ import { GenerableType } from '../../../../Config/exports/Mapping';
 import { ConditionOrValue, OrConditionShape } from '../../types';
 import { Condition } from '../Condition';
 
+/**
+ * True if any argument is truthy.
+ * @see {@link https://circleci.com/docs/configuration-reference#logic-statements}
+ */
 export class Or extends Condition {
  conditions: Condition[];
 

src/lib/Config/Pipeline/Git.ts

@@ -1,3 +1,7 @@
+/**
+ * Not fully implemented yet. Fetch git pipeline parameters from inside a CircleCI job.
+ * @alpha
+ */
 export class Git {
  public _isLocal = true;
  constructor(isLocal: boolean) {

src/lib/Config/Pipeline/Project.ts

@@ -1,7 +1,8 @@
 export type VCSLiteral = 'bitbucket' | 'github' | 'local';
 
 /**
- * Pipeline Project level information
+ * Not fully implemented yet. Fetch project pipeline parameters from inside a CircleCI job.
+ * @alpha
  */
 export class Project {
  private _isLocal: boolean;

src/lib/Config/Pipeline/index.ts

@@ -1,7 +1,8 @@
 import { Project } from './Project';
 import { Git } from './Git';
 /**
- * Access Pipeline variables from within CircleCI Cloud.
+ * Not fully implemented yet. Fetch pipeline parameters from inside a CircleCI job.
+ * @alpha
  */
 export class Pipeline {
  /**

src/lib/Orb/exports/OrbImport.ts

@@ -10,6 +10,10 @@ import { GenerableType } from '../../Config/exports/Mapping';
 import { OrbDisplayMeta, OrbImportManifest } from '../types/Orb.types';
 import { OrbRef } from './OrbRef';
 
+/**
+ * A reference to an imported Orb.
+ * {@label STATIC_2.1}
+ */
 export class OrbImport implements Generable {
  alias: string;
  namespace: string;

src/lib/Orb/exports/OrbRef.ts

@@ -5,6 +5,7 @@ import { OrbImport } from './OrbImport';
 
 /**
  * An abstract reference to an orb component.
+ * {@label STATIC_2.1}
  */
 export class OrbRef<Literal extends AnyParameterLiteral> {
  private _parameters: CustomParametersList<Literal>;