File: document.el.html
Routines for fabricating human readable text from function and variable names as base-text for function comments. Document is not meant to generate end-text for any function. It is merely meant to provide some useful base words and text, and as a framework for managing comments.
Defined variables (6)
srecode-document-autocomment-common-nouns-abbrevs | List of common English abbreviations or full words. |
srecode-document-autocomment-function-alist | List of names to string match against the function name. |
srecode-document-autocomment-param-alist | Alist of common variable names appearing as function parameters. |
srecode-document-autocomment-param-type-alist | Alist of input parameter types and strings describing them. |
srecode-document-autocomment-return-first-alist | List of regexp matches for types. |
srecode-document-autocomment-return-last-alist | List of regexps which provide the type of the return value. |
Defined functions (10)
srecode-document-function-name-comment | (TAG) |
srecode-document-insert-comment | () |
srecode-document-insert-function-comment | (&optional FCN-IN) |
srecode-document-insert-group-comments | (BEG END) |
srecode-document-insert-section-comment | (&optional TITLE) |
srecode-document-insert-variable-one-line-comment | (&optional VAR-IN) |
srecode-document-one-line-tag-p | (TAG) |
srecode-document-parameter-comment | (PARAM &optional COMMENTLIST) |
srecode-document-programmer->english | (PROGRAMMER) |
srecode-document-trim-whitespace | (STR) |