Document private functions with @internal tag (#2205)

Author: Enda

src/execution/execute.js

@@ -244,6 +244,8 @@ function buildResponse(
 /**
  * Essential assertions before executing to provide developer feedback for
  * improper use of the GraphQL library.
+ *
+ * @internal
  */
 export function assertValidExecutionArguments(
   schema: GraphQLSchema,
@@ -267,6 +269,8 @@ export function assertValidExecutionArguments(
  * execute, which we will pass throughout the other execution methods.
  *
  * Throws a GraphQLError if a valid execution context cannot be created.
+ *
+ * @internal
  */
 export function buildExecutionContext(
   schema: GraphQLSchema,
@@ -465,6 +469,8 @@ function executeFields(
  * CollectFields requires the "runtime type" of an object. For a field which
  * returns an Interface or Union type, the "runtime type" will be the actual
  * Object type returned by that field.
+ *
+ * @internal
  */
 export function collectFields(
   exeContext: ExecutionContext,
@@ -641,6 +647,9 @@ function resolveField(
   );
 }
 
+/**
+ * @internal
+ */
 export function buildResolveInfo(
   exeContext: ExecutionContext,
   fieldDef: GraphQLField<mixed, mixed>,
@@ -664,8 +673,12 @@ export function buildResolveInfo(
   };
 }
 
-// Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField`
-// function. Returns the result of resolveFn or the abrupt-return Error object.
+/**
+ * Isolates the "ReturnOrAbrupt" behavior to not de-opt the `resolveField`
+ * function. Returns the result of resolveFn or the abrupt-return Error object.
+ *
+ * @internal
+ */
 export function resolveFieldValueOrError(
   exeContext: ExecutionContext,
   fieldDef: GraphQLField<mixed, mixed>,
@@ -1192,6 +1205,8 @@ export const defaultFieldResolver: GraphQLFieldResolver<
  * are allowed, like on a Union. __schema could get automatically
  * added to the query type, but that would require mutating type
  * definitions, which would cause issues.
+ *
+ * @internal
  */
 export function getFieldDef(
   schema: GraphQLSchema,

src/execution/values.js

@@ -41,6 +41,8 @@ type CoercedVariableValues =
  * Note: The returned value is a plain Object with a prototype, since it is
  * exposed to user code. Care should be taken to not pull values from the
  * Object prototype.
+ *
+ * @internal
  */
 export function getVariableValues(
   schema: GraphQLSchema,
@@ -153,6 +155,8 @@ function coerceVariableValues(
  * Note: The returned value is a plain Object with a prototype, since it is
  * exposed to user code. Care should be taken to not pull values from the
  * Object prototype.
+ *
+ * @internal
  */
 export function getArgumentValues(
   def: GraphQLField<mixed, mixed> | GraphQLDirective,

src/language/blockString.js

@@ -5,6 +5,8 @@
  * CoffeeScript's block string, Python's docstring trim or Ruby's strip_heredoc.
  *
  * This implements the GraphQL spec's BlockStringValue() static algorithm.
+ *
+ * @internal
  */
 export function dedentBlockStringValue(rawString: string): string {
   // Expand a block string's raw value into independent lines.
@@ -30,8 +32,9 @@ export function dedentBlockStringValue(rawString: string): string {
   // Return a string of the lines joined with U+000A.
   return lines.join('\n');
 }
-
-// @internal
+/**
+ * @internal
+ */
 export function getBlockStringIndentation(
   lines: $ReadOnlyArray<string>,
 ): number {
@@ -71,6 +74,8 @@ function isBlank(str) {
  * Print a block string in the indented block form by adding a leading and
  * trailing blank line. However, if a block string starts with whitespace and is
  * a single-line, adding a leading blank line would strip that whitespace.
+ *
+ * @internal
  */
 export function printBlockString(
   value: string,

src/language/lexer.js

@@ -93,7 +93,9 @@ export type Lexer<TOptions> = {
   ...
 };
 
-// @internal
+/**
+ * @internal
+ */
 export function isPunctuatorTokenKind(kind: TokenKindEnum) {
   return (
     kind === TokenKind.BANG ||

src/type/definition.js

@@ -822,6 +822,9 @@ function fieldsToFieldsConfig(fields) {
   }));
 }
 
+/**
+ * @internal
+ */
 export function argsToArgsConfig(
   args: $ReadOnlyArray<GraphQLArgument>,
 ): GraphQLFieldConfigArgumentMap {

src/validation/rules/KnownArgumentNames.js

@@ -45,7 +45,9 @@ export function KnownArgumentNames(context: ValidationContext): ASTVisitor {
   };
 }
 
-// @internal
+/**
+ * @internal
+ */
 export function KnownArgumentNamesOnDirectives(
   context: ValidationContext | SDLValidationContext,
 ): ASTVisitor {

src/validation/rules/ProvidedRequiredArguments.js

@@ -71,7 +71,9 @@ export function ProvidedRequiredArguments(
   };
 }
 
-// @internal
+/**
+ * @internal
+ */
 export function ProvidedRequiredArgumentsOnDirectives(
   context: ValidationContext | SDLValidationContext,
 ): ASTVisitor {

src/validation/specifiedRules.js

@@ -60,7 +60,7 @@ import { UniqueDirectivesPerLocation } from './rules/UniqueDirectivesPerLocation
 // Spec Section: "Argument Names"
 import {
   KnownArgumentNames,
-  KnownArgumentNamesOnDirectives, // @internal
+  KnownArgumentNamesOnDirectives,
 } from './rules/KnownArgumentNames';
 
 // Spec Section: "Argument Uniqueness"
@@ -72,7 +72,7 @@ import { ValuesOfCorrectType } from './rules/ValuesOfCorrectType';
 // Spec Section: "Argument Optionality"
 import {
   ProvidedRequiredArguments,
-  ProvidedRequiredArgumentsOnDirectives, // @internal
+  ProvidedRequiredArgumentsOnDirectives,
 } from './rules/ProvidedRequiredArguments';
 
 // Spec Section: "All Variable Usages Are Allowed"
@@ -127,7 +127,9 @@ import { UniqueFieldDefinitionNames } from './rules/UniqueFieldDefinitionNames';
 import { UniqueDirectiveNames } from './rules/UniqueDirectiveNames';
 import { PossibleTypeExtensions } from './rules/PossibleTypeExtensions';
 
-// @internal
+/**
+ * @internal
+ */
 export const specifiedSDLRules = Object.freeze([
   LoneSchemaDefinition,
   UniqueOperationTypes,

src/validation/validate.js

@@ -82,7 +82,9 @@ export function validate(
   return errors;
 }
 
-// @internal
+/**
+ * @internal
+ */
 export function validateSDL(
   documentAST: DocumentNode,
   schemaToExtend?: ?GraphQLSchema,

tstypes/language/blockString.d.ts

@@ -6,7 +6,9 @@
  */
 export function dedentBlockStringValue(rawString: string): string;
 
-// @internal
+/**
+ * @internal
+ */
 export function getBlockStringIndentation(lines: ReadonlyArray<string>): number;
 
 /**