[Feature Request] @ReleaseNotes support in Doxygen
|
View:
New views
2 Messages
—
Rating Filter:
Alert me
|
 |
[Feature Request] @ReleaseNotes support in Doxygen
by Stefan-Heiss
() ::
Rate this Message:
I'm not sure if a ReleaseNotes feature in doxygen has been already proposed. I'm personally using Doxygen since quite a while and also for different projects. The tools is great. However, I'm somehow missing a possiblity to automatically generate my ReleaseNotes from Doxygen automatically. Therefore I post here...
I propose following feature: - implement new keyword that allows entering release-notes distributed over a software project @RelNote [ReleaseNumber] [Type=<BugFix|Feature|Others>] [BugOrFeatureRequest-ID-Number] {Description} ReleaseNumber: Release or Build number since when this bugfix/feature is implemented Type: Qualifier if this comment is a bugfix or FeatureRequest, etc... BugOrFeatureRequest-ID-Number: any ID number from bug-tracking system Description: Text, describing what has been fixed, added, etc.... - All release notes shall be ending up in its own doxygen page. The page can be enabled, disabled just like the Todo or Test page. - Doxygen will order the output in the ReleasePage according to ReleaseNumber, for instance, so that all entries of the same ReleaseNumber are being grouped together. |
|
|
Re: [Feature Request] @ReleaseNotes support in Doxygen
by SmokingRope
::
Rate this Message:
I have been considering a similar feature. I may even start development soon. My goal was to track changes made to the source code. Most of it can be accomplished with an alias.
ALIASES += changelog{1}="\xrefitem changes \"Change Made\" \"Change Log\" <b>\1</b>: " This alias creates an index page called changes consisting of all \changelog commands encountered by doxygen. The first parameter is used as the heading for that particular instance of the command. I used it as follows: \changelog 06-16-2008 added a new feature However it is not possible to sort with the elements, it would be ideal to maintain a list of these elements in descending order based on date. Your second requirement is very similar and provides a good second perspective on what type of things might be needed in a sortable index. Perhaps given a command like "\sortedxrefitem" you could use an alias similar to the above to accomplish your own goals? On Mon, Jun 16, 2008 at 2:44 AM, Stefan-Heiss <Stefan.heiss@...> wrote:
------------------------------------------------------------------------- Check out the new SourceForge.net Marketplace. It's the best place to buy or sell services for just about anything Open Source. http://sourceforge.net/services/buy/index.php _______________________________________________ Doxygen-develop mailing list Doxygen-develop@... https://lists.sourceforge.net/lists/listinfo/doxygen-develop |
| Free Forum Powered by Nabble | Forum Help |
