Inline flag @private
Brought to you by:
doughellmann,
krlosaqp
By default, every function/class in the code appears in
the generation documentation.
Using the _foo names is an alternative to mark an item
as "private", thus not including it in the doc.
In case of already written code, where using private
names means changing the code in multiple places, it
would be handy to handle a @private flag (a la
"javadoc") to mark an item private without changing its
name.
Eg :
def myFunc():
# @private
Logged In: YES
user_id=34486
Should the flag be inside the docstring?
Maybe a better solution would be to expand on the embedded
control variables idea so that there could be
object-specific settings. This would also allow for
different docstring converters for different classes within
a file.