Results 1 to 2 of 2

Thread: auto generated doxygen tags

  1. #1
    Join Date
    Nov 2008
    Posts
    183
    Thanks
    13
    Thanked 2 Times in 2 Posts
    Qt products
    Qt4
    Platforms
    Unix/X11

    Default auto generated doxygen tags

    Does anyone know the reasoning behind filling in \brief with the same class information doxygen generates automatically? Is there a method in QtCreator to override the default contents of this tag?

    What am I talking about? Assume we have the following method in a class source file.

    void MyClass::methodDoesSomething( int x, double y)
    {
    ...
    }

    when you place your cursor above the method and type /*! then hit enter you will get a series of doxygen comments auto-generated.

    * \brief MyClass::methodDoesSomething
    * \param blah
    * \param blah

    The default value for brief isn't useful. Is this deliberate so it sticks out like a sore thumb in the documentation or is there a manner of overriding the default contents of \brief?

    Thanks,

  2. #2
    Join Date
    Jan 2006
    Location
    Graz, Austria
    Posts
    8,416
    Thanks
    37
    Thanked 1,544 Times in 1,494 Posts
    Qt products
    Qt3 Qt4 Qt5
    Platforms
    Unix/X11 Windows

    Default Re: auto generated doxygen tags

    I guess it is the latter since Creator can't really know whether your doxygen config uses the auto-brief mode or not.

    Cheers,
    _

Similar Threads

  1. License for auto-generated code
    By undp in forum Qt Quick
    Replies: 2
    Last Post: 17th January 2012, 22:08
  2. Renaming auto-generated UI class
    By orfner in forum Qt Tools
    Replies: 2
    Last Post: 8th September 2011, 20:33
  3. Doxygen and Qt... is there a FAQ?
    By Coises in forum Qt Tools
    Replies: 6
    Last Post: 21st June 2010, 20:45
  4. qt_plugins_3.3rc auto-generated with embedded paths
    By kevinm in forum Installation and Deployment
    Replies: 0
    Last Post: 20th October 2008, 16:22
  5. Doxygen and Qt Classes
    By chaosgeorge in forum Qt Programming
    Replies: 6
    Last Post: 10th December 2006, 00:38

Tags for this Thread

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide.