docs(project): add documentation comments to Fury

Author: kylef

packages/fury-adapter-oas3-parser/lib/parser/oas/parseComponentsObject.js

@@ -28,6 +28,7 @@ const valueIsObject = R.compose(isObject, getValue);
  *
  * @param parseResult {ParseResult}
  * @returns boolean
+ * @private
  */
 const isParseResultEmpty = parseResult => R.reject(isAnnotation, parseResult).isEmpty;
 
@@ -48,6 +49,7 @@ const isParseResultEmpty = parseResult => R.reject(isAnnotation, parseResult).is
  *   the reusable component
  *
  * @returns ParseResult
+ * @private
  */
 const parseComponentMember = R.curry((context, parser, member) => {
   // Create a Member Element with `member.key` as the key
@@ -77,6 +79,7 @@ const parseComponentMember = R.curry((context, parser, member) => {
  * @returns ParseResult
  *
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#componentsObject
+ * @private
  */
 function parseComponentsObject(context, element) {
   const { namespace } = context;
@@ -106,6 +109,7 @@ function parseComponentsObject(context, element) {
    * @param member {Member}
    *
    * @returns ParseResult
+   * @private
    */
   const parseComponentObjectMember = (parser) => {
     const parseMember = parseComponentMember(context, parser);

packages/fury-adapter-oas3-parser/lib/parser/oas/parseHeaderObject.js

@@ -21,6 +21,7 @@ const isUnsupportedKey = R.anyPass(R.map(hasKey, unsupportedKeys));
  * @returns ParseResult
  *
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#headerObject
+ * @private
  */
 function parseHeaderObject(context, object) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parseInfoObject.js

@@ -21,13 +21,15 @@ const unsupportedKeys = ['termsOfService', 'contact', 'license'];
  * @param member {MemberElement}
  * @returns {boolean}
  * @see unsupportedKeys
+ * @private
  */
 const isUnsupportedKey = R.anyPass(R.map(hasKey, unsupportedKeys));
 
 /**
  * Parse the OpenAPI 'Info Object' (`#/info`)
  * @see https://github.com/OAI/OpenAPI-Specification/blob/50c152549263cda0f05608d514ba78546b390d0e/versions/3.0.0.md#infoObject
  * @returns ParseResult<Category>
+ * @private
  */
 function parseInfo(context, info) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parseMediaTypeObject.js

@@ -53,6 +53,7 @@ const parseSchema = parseReference('schemas', parseSchemaObject);
  * @returns ParseResult
  *
  * @see https://github.com/OAI/OpenAPI-Specification/blob/50c152549263cda0f05608d514ba78546b390d0e/versions/3.0.0.md#media-type-object
+ * @private
  */
 function parseMediaTypeObject(context, MessageBodyClass, element) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parseOpenAPIObject.js

@@ -25,6 +25,7 @@ const unsupportedKeys = ['servers', 'security', 'tags', 'externalDocs'];
  * @param member {MemberElement}
  * @returns {boolean}
  * @see unsupportedKeys
+ * @private
  */
 const isUnsupportedKey = R.anyPass(R.map(hasKey, unsupportedKeys));
 

packages/fury-adapter-oas3-parser/lib/parser/oas/parseOperationObject.js

@@ -87,6 +87,7 @@ function hrefFromParameters(path, queryParameters) {
  * @returns ParseResult<Transition>
  *
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject
+ * @private
  */
 function parseOperationObject(context, path, member) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parseParameterObject.js

@@ -61,6 +61,7 @@ function validateRequiredForPathParameter(context, object, parameter) {
  * @returns ParseResult
  *
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#parameterObject
+ * @private
  */
 function parseParameterObject(context, object) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parseParameterObjects.js

@@ -20,6 +20,7 @@ const isPathOrQuery = R.anyPass([hasKey('path'), hasKey('query')]);
  * @return {ParseResult<ObjectElement>} An object containing parameters grouped
  *   by their `in` value (`path`, `query` etc) as members. The object can
  *   be treated as a "named tuple".
+ * @private
  */
 function parseParameterObjects(context, name, array) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parsePathItemObject.js

@@ -24,6 +24,7 @@ const isUnsupportedKey = R.anyPass(R.map(hasKey, unsupportedKeys));
  * For example `/{resource}` would return `['resource']`
  * @param path {string}
  * @return array
+ * @private
  */
 function extractPathVariables(path) {
   const matches = path.match(/({.*?})/gm);
@@ -45,6 +46,7 @@ function createErrorForMissingPathVariable(namespace, path, variable) {
  * @param path {StringElement}
  * @param hrefVariables {HrefVariables}
  * @retuns ParseResult<HrefVariables>
+ * @private
  */
 const validateHrefVariablesInPath = R.curry((namespace, path, hrefVariables) => {
   const pathVariables = extractPathVariables(path.toValue());
@@ -65,6 +67,7 @@ const validateHrefVariablesInPath = R.curry((namespace, path, hrefVariables) =>
  * @param namespace
  * @param path {StringElement}
  * @param member {MemberElement} parameters member from an object element
+ * @private
  */
 function parseParameters(context, path, member) {
   const { namespace } = context;
@@ -114,6 +117,7 @@ function hrefFromParameters(path, parameters) {
  * Parse Path Item Object
  * @returns Resource
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#path-item-object
+ * @private
  */
 function parsePathItemObject(context, member) {
   const { namespace } = context;

packages/fury-adapter-oas3-parser/lib/parser/oas/parsePathsObject.js

@@ -13,6 +13,7 @@ const isPathField = member => member.key.toValue().startsWith('/');
  * Parse Paths Object
  * @returns ParseResult<Resource>
  * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#pathsObject
+ * @private
  */
 function parsePaths(context, paths) {
   const { namespace } = context;