Author Topic: Feature: Documentation tags for date, author, CVS/SVN etc.  (Read 4764 times)

lancent

  • Guest
It would be fine to get some built-in documentation tags that always keep actual. This is an enourmous problem in documentation... it gets older...

So it would be great if codeblocks would allow Documentation tags like:

@author
@date
@cvsdocid -> version number from cvs/svn

etc.

and keep those informations actual!

Best wishes,

lancent.

FocusedWolf

  • Guest
Re: Feature: Documentation tags for date, author, CVS/SVN etc.
« Reply #1 on: February 19, 2006, 09:03:45 pm »
I like the c# styled xml comments better. It's in the doxygen wish list so pretty soon it will be very common. Java doc...thats the old, ugly, (standard), Java, way  :lol:

Code
        /// <summary>
        /// Implements the OnBeginShutdown method of the IDTExtensibility2
        /// interface. Receives notification that the host application is being
        /// unloaded.
        /// </summary>
/// <param term='custom'>Array of parameters that are host application specific.</param>
/// <seealso class='IDTExtensibility2' />
public void OnBeginShutdown(ref Array custom)
{
            if (this._editor != null)
            {
                this._editor.Close();
            }
}
« Last Edit: February 19, 2006, 09:10:02 pm by FocusedWolf »

Offline thomas

  • Administrator
  • Lives here!
  • *****
  • Posts: 3979
Re: Feature: Documentation tags for date, author, CVS/SVN etc.
« Reply #2 on: February 19, 2006, 09:10:53 pm »
This can be done easily.

Look on top of any of Code::Blocks' .cpp files to learn how this is done or read this:
http://svnbook.red-bean.com/en/1.1/svn-book.html#svn-ch-7-sect-2.3.4


EDIT:
This is not a specific svn feature, you can do the very same with cvs too (although the syntax is slightly different). I am just giving svn as an example because that's the revision control system I am used to.
« Last Edit: February 19, 2006, 09:15:07 pm by thomas »
"We should forget about small efficiencies, say about 97% of the time: Premature quotation is the root of public humiliation."