Results 1 to 16 of 16

Thread: how to document classes and member functions?

Threaded View

Previous Post Previous Post   Next Post Next Post
  1. #1
    Join Date
    Mar 2011
    Posts
    13
    Thanks
    3
    Qt products
    Qt4
    Platforms
    Windows

    Default how to document classes and member functions?

    I'm having problems with writing documentations for my classes and their member functions. I've found what I want in Qt base classes. Here are several rows from "QVector.cpp":
    Qt Code:
    1. /*!
    2.   \class QVector
    3.   \brief The QVector class is a template class that provides a dynamic array.
    4.  
    5.   \ingroup tools
    6.   \ingroup shared
    7.  
    8.   \reentrant
    9.  
    10.   QVector\<T\> is one of Qt's generic \l{container classes}. It
    11.   stores its items in adjacent memory locations and provides fast
    12.   index-based access.
    13.  
    14.   QList\<T\>, QLinkedList\<T\>, and QVarLengthArray\<T\> provide
    15.   similar functionality. Here's an overview:
    16.  
    17.   \list
    18.   \i For most purposes, QList is the right class to use. Operations
    19.   like prepend() and insert() are usually faster than with
    20. ..........
    21. */
    22.  
    23. /*!
    24.   \fn QVector<T> QVector::mid(int pos, int length = -1) const
    25.  
    26.   Returns a vector whose elements are copied from this vector....
    27.   .........
    28. */
    29. // ....
    To copy to clipboard, switch view to plain text mode 


    When I'm trying to do the same in my ".cpp" files, nothing happens (hovering the functions' calls in other files doesn't show my documentation). I tried to find some documentation about this and the keywords (tags) as well (like "\class", "\brief", "\ingroup"...), but I couldn't find anything. Can anyone help or give any links to documentation concerning this?
    Last edited by jackal; 4th April 2011 at 13:37.

Similar Threads

  1. Replies: 1
    Last Post: 16th March 2011, 08:10
  2. Replies: 5
    Last Post: 17th November 2010, 17:29
  3. Question about functions in classes
    By cwnelatury in forum Newbie
    Replies: 1
    Last Post: 13th May 2009, 06:05
  4. Pointers to Member Functions
    By Doug Broadwell in forum General Programming
    Replies: 8
    Last Post: 15th May 2007, 23:08
  5. emiting signals from const member functions !?
    By sunil.thaha in forum Qt Programming
    Replies: 2
    Last Post: 25th March 2006, 11:29

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
  •  
Qt is a trademark of The Qt Company.