Changeset 34 for trunk


Ignore:
Timestamp:
Jul 23, 2006, 9:53:03 AM (13 years ago)
Author:
jtv
Message:

Generated documentation!

Location:
trunk
Files:
1 added
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/README

    r30 r34  
    88This package is for programmers who want to write their own version of the
    99famous little puzzle game.  (If you think you know the game from soup to nuts
    10 and it's boring, do read on)
     10and it's boring, do read on).  Building libmines requires a somewhat Unix-like
     11system and the GNU version of "make"--it may be installed on your system as
     12"gmake".
    1113
    1214Everybody's got their own version of Minesweeper.  All of them are essentially
     
    111113To start using libmines in C++, take a look at the source files with names
    112114ending in ".hxx".  These headers define the C++ API.  The C interface is defined
    113 in a header called c_abi.h.  All of these are commented in a format suitable for
    114 auto-documentation tools like Doxygen.
     115in a header called c_abi.h.
    115116
     117For more easily readable documentation on how to use libmines in your own
     118program, see the documentation in the "doc" directory.  If you would like to
     119have this documentation generated in other formats such as LaTeX, ensure that
     120the documentation extractor "doxygen" is installed on your system; edit the
     121configuration file doc/Doxyfile accordingly, then run "make".
     122
  • trunk/include/c_abi.h

    r31 r34  
    1818*/
    1919
    20 /* C API/ABI to C++ Minesweeper implementation
     20/** @addtogroup CAPI C API/ABI to C++ Minesweeper implementation
    2121 */
     22//@{
     23
    2224#ifdef __cplusplus
    2325extern "C"
     
    9092#endif
    9193
     94//@}
     95//
  • trunk/include/gamelogic.hxx

    r33 r34  
    1818*/
    1919
    20 // This file defines the native C++ API to libmines
     20/** @addtogroup CXXAPI Native C++ API to libmines
     21 */
     22//@{
    2123
    2224#include <set>
     
    175177};
    176178
     179//@}
     180
Note: See TracChangeset for help on using the changeset viewer.