Variable: srecode-document-autocomment-function-alist

srecode-document-autocomment-function-alist is a customizable variable defined in document.el.gz.

Value

(("abort" . "Aborts the")
 ("realloc" . "moves or ")
 ("alloc\\(ate\\)?" . "Allocates and initializes a new ")
 ("clean" . "Cleans up the")
 ("clobber" . "Removes")
 ("close" . "Cleanly closes")
 ("check" . "Checks the")
 ("comp\\(are\\)?" . "Compares the")
 ("create" . "Creates a new ")
 ("find" . "Finds ")
 ("free" . "Frees up space")
 ("gen\\(erate\\)?" . "Generates a new ")
 ("get\\|find" . "Looks for the given ")
 ("gobble" . "Removes")
 ("he?lp" . "Provides help for")
 ("li?ste?n" . "Listens for ")
 ("connect" . "Connects to ")
 ("acc?e?pt" . "Accepts a ")
 ("load" . "Loads in ")
 ("match" . "Check that parameters match")
 ("name" . "Provides a name which ")
 ("new" . "Allocates a ")
 ("parse" . "Parses the parameters and returns ")
 ("print\\|display" . "Prints out")
 ("read" . "Reads from")
 ("reset" . "Resets the parameters and returns")
 ("scan" . "Scans the ")
 ("setup\\|init\\(ialize\\)?" . "Initializes the ")
 ("select" . "Chooses the ")
 ("send" . "Sends a")
 ("re?c\\(v\\|ieves?\\)" . "Receives a ")
 ("to" . "Converts ")
 ("update" . "Updates the ")
 ("wait" . "Waits for ")
 ("write" . "Writes to"))

Documentation

List of names to string match against the function name.

This is an alist with each element of the form:
 (MATCH . RESULT)
MATCH is a regexp to match in the type field. RESULT is a string.

Certain prefixes may always mean the same thing, and the same comment can be used as a beginning for the description. Regexp should be lower case since the string they are compared to is downcased. A string may end in a space, in which case, last-alist is searched to see how best to describe what can be returned. Doesn't always work correctly, but that is just because English doesn't always work correctly.

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/srecode/document.el.gz
(defcustom srecode-document-autocomment-function-alist
  '(
    ("abort" . "Aborts the")
    ;; trick to get re-alloc and alloc to pair into one sentence.
    ("realloc" . "moves or ")
    ("alloc\\(ate\\)?" . "Allocates and initializes a new ")
    ("clean" . "Cleans up the")
    ("clobber" . "Removes")
    ("close" . "Cleanly closes")
    ("check" . "Checks the")
    ("comp\\(are\\)?" . "Compares the")
    ("create" . "Creates a new ")
    ("find" . "Finds ")
    ("free" . "Frees up space")
    ("gen\\(erate\\)?" . "Generates a new ")
    ("get\\|find" . "Looks for the given ")
    ("gobble" . "Removes")
    ("he?lp" . "Provides help for")
    ("li?ste?n" . "Listens for ")
    ("connect" . "Connects to ")
    ("acc?e?pt" . "Accepts a ")
    ("load" . "Loads in ")
    ("match" . "Check that parameters match")
    ("name" . "Provides a name which ")
    ("new" . "Allocates a ")
    ("parse" . "Parses the parameters and returns ")
    ("print\\|display" . "Prints out")
    ("read" . "Reads from")
    ("reset" . "Resets the parameters and returns")
    ("scan" . "Scans the ")
    ("setup\\|init\\(ialize\\)?" . "Initializes the ")
    ("select" . "Chooses the ")
    ("send" . "Sends a")
    ("re?c\\(v\\|ieves?\\)" . "Receives a ")
    ("to" . "Converts ")
    ("update" . "Updates the ")
    ("wait" . "Waits for ")
    ("write" . "Writes to")
    )
  "List of names to string match against the function name.
This is an alist with each element of the form:
 (MATCH . RESULT)
MATCH is a regexp to match in the type field.
RESULT is a string.

Certain prefixes may always mean the same thing, and the same comment
can be used as a beginning for the description.  Regexp should be
lower case since the string they are compared to is downcased.
A string may end in a space, in which case, last-alist is searched to
see how best to describe what can be returned.
Doesn't always work correctly, but that is just because English
doesn't always work correctly."
  :type '(repeat (cons (regexp :tag "Regexp")
		       (string :tag "Doc Text"))))