Menu

#93 Documenting changes in the documentation

open
Other (25)
5
2008-09-24
2008-09-24
No

I dream with such a tag @change or @change-log that could be used to document a change in any documentable sentence (class, function, whatever). For example:

"""
My ultra-usefull class.

@change yyyyMMdd [#nnn] description here.
@change yyyyMMdd another change.
"""

The [#nnn] is optional and should be the bugtracker ID for any bugtracker. The user could configure the URL to the bugtracker as a template for substitution with the ID found in @change tags.

On the rendered documentation, change lists is rendered for each sentence and the whole documentation set includes a page with "all changes" list.

Discussion


Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.