IF Commons GitHub

extensions/docs/text

The text of documentation comments (commons lang-sql 0004-sql-docs FR-001): a comment with its markers taken off, whatever kind it is. A line comment loses its marker, any run of the marker's last character that follows it (---, ///, ##) and one space; a block comment loses its delimiters, and on each line its white space, any * and one space; consecutive comments are joined by a new line.

docText(parse("--- The people.\n--- Of the company.\nCREATE TABLE t (a INT)").comments); // "The people.\nOf the company."

Spec: 0004-sql-docs FR-001

Source: commons/lang-sql/src/extensions/docs/text.ts

1 of 1 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

docTextfunction
function docText(comments: readonly Comment[]): string

The documentation text of comments, in order, joined by new lines.

ParameterWhat it is
commentscomments of any kind

Returns: their text with the markers taken off

Imported by 8 tests of the run (8 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.