Function comment header formatting corrections

This commit is contained in:
William S Fulton 2015-07-28 00:32:31 +01:00
commit a779f9bbc1

View file

@ -1346,6 +1346,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* funcCall() * funcCall()
*
* Emit shadow code to call a function in the extension * Emit shadow code to call a function in the extension
* module. Using proper argument and calling style for * module. Using proper argument and calling style for
* given node n. * given node n.
@ -1574,6 +1575,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* have_docstring() * have_docstring()
*
* Check if there is a docstring directive and it has text, * Check if there is a docstring directive and it has text,
* or there is an autodoc flag set * or there is an autodoc flag set
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -1585,6 +1587,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* docstring() * docstring()
*
* Get the docstring text, stripping off {} if neccessary, * Get the docstring text, stripping off {} if neccessary,
* and enclose in triple double quotes. If autodoc is also * and enclose in triple double quotes. If autodoc is also
* set then it will build a combined docstring. * set then it will build a combined docstring.
@ -1650,6 +1653,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* cdocstring() * cdocstring()
*
* Get the docstring text as it would appear in C-language * Get the docstring text as it would appear in C-language
* source code. * source code.
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -1680,6 +1684,7 @@ public:
/* ----------------------------------------------------------------------------- /* -----------------------------------------------------------------------------
* addMissingParameterNames() * addMissingParameterNames()
*
* For functions that have not had nameless parameters set in the Language class. * For functions that have not had nameless parameters set in the Language class.
* *
* Inputs: * Inputs:
@ -1705,6 +1710,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* make_autodocParmList() * make_autodocParmList()
*
* Generate the documentation for the function parameters * Generate the documentation for the function parameters
* Parameters: * Parameters:
* func_annotation: Function annotation support * func_annotation: Function annotation support
@ -1813,6 +1819,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* make_autodoc() * make_autodoc()
*
* Build a docstring for the node, using parameter and other * Build a docstring for the node, using parameter and other
* info in the parse tree. If the value of the autodoc * info in the parse tree. If the value of the autodoc
* attribute is "0" then do not include parameter types, if * attribute is "0" then do not include parameter types, if
@ -1958,6 +1965,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* convertDoubleValue() * convertDoubleValue()
*
* Check if the given string looks like a decimal floating point constant * Check if the given string looks like a decimal floating point constant
* and return it if it does, otherwise return NIL. * and return it if it does, otherwise return NIL.
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2001,6 +2009,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* convertValue() * convertValue()
*
* Check if string v can be a Python value literal or a * Check if string v can be a Python value literal or a
* constant. Return NIL if it isn't. * constant. Return NIL if it isn't.
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2124,6 +2133,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* is_representable_as_pyargs() * is_representable_as_pyargs()
*
* Check if the function parameters default argument values * Check if the function parameters default argument values
* can be represented in Python. * can be represented in Python.
* *
@ -2171,6 +2181,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* is_real_overloaded() * is_real_overloaded()
*
* Check if the function is overloaded, but not just have some * Check if the function is overloaded, but not just have some
* siblings generated due to the original function have * siblings generated due to the original function have
* default arguments. * default arguments.
@ -2197,6 +2208,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* make_pyParmList() * make_pyParmList()
*
* Generate parameter list for Python functions or methods, * Generate parameter list for Python functions or methods,
* reuse make_autodocParmList() to do so. * reuse make_autodocParmList() to do so.
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2244,6 +2256,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* have_pythonprepend() * have_pythonprepend()
*
* Check if there is a %pythonprepend directive and it has text * Check if there is a %pythonprepend directive and it has text
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2254,6 +2267,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* pythonprepend() * pythonprepend()
*
* Get the %pythonprepend code, stripping off {} if neccessary * Get the %pythonprepend code, stripping off {} if neccessary
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2269,6 +2283,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* have_pythonappend() * have_pythonappend()
*
* Check if there is a %pythonappend directive and it has text * Check if there is a %pythonappend directive and it has text
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2281,6 +2296,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* pythonappend() * pythonappend()
*
* Get the %pythonappend code, stripping off {} if neccessary * Get the %pythonappend code, stripping off {} if neccessary
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2299,6 +2315,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* have_addtofunc() * have_addtofunc()
*
* Check if there is a %addtofunc directive and it has text * Check if there is a %addtofunc directive and it has text
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2309,6 +2326,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* returnTypeAnnotation() * returnTypeAnnotation()
*
* Helper function for constructing the function annotation * Helper function for constructing the function annotation
* of the returning type, return a empty string for Python 2.x * of the returning type, return a empty string for Python 2.x
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */
@ -2343,6 +2361,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* emitFunctionShadowHelper() * emitFunctionShadowHelper()
*
* Refactoring some common code out of functionWrapper and * Refactoring some common code out of functionWrapper and
* dispatchFunction that writes the proxy code for non-member * dispatchFunction that writes the proxy code for non-member
* functions. * functions.
@ -2374,6 +2393,7 @@ public:
/* ------------------------------------------------------------ /* ------------------------------------------------------------
* check_kwargs() * check_kwargs()
*
* check if using kwargs is allowed for this Node * check if using kwargs is allowed for this Node
* ------------------------------------------------------------ */ * ------------------------------------------------------------ */