doc/developing.doxy

Go to the documentation of this file.

 namespace hp3Dedge {
   // leave this empty, just for documentation
 } @endverbatim

    Then, you need to modify the top level <tt>Jamfile</tt>
    and register the new project there. Ie., you have to add the name
    of the project with <tt>build-project</tt>.

    @subsubsection file-cont Contents of a Jamfile

    A <tt>Jamfile</tt> holds the following information:

    - <tt>project</tt>:
      The name of the project. This is identical with the name of the
      subdirectory.
    - <tt>usage-requirements</tt>:
      The names of the projects on which the current project depends (on
      the linking level, source level dependencies [<tt>#include</tt>] is
      handled automatically).
    - <tt>SOURCES</tt>, <tt>lib</tt>
      <tt>exe</tt>, <tt>obj</tt>, <tt>unit-test</tt>:
      The files which are built in this project.

    <b>Examples</b> can be found in <tt>geometry</tt>
    for a normal project and <tt>applications</tt>
    for the applications project.

    @section building Building Concepts

    Changing into any source directory (or staying in the top level directory) 
    and calling <tt>bjam</tt> should build the library and the
    executables.  If you want to rebuild a subpart, you can
    issue <tt>bjam</tt> in its subdirectory again.

    @section cvs Version Managment with CVS

    Documentation on CVS can be found
    <a href="http://www.loria.fr/~molli/cvs/doc/cvs_toc.html">here</a>
    and <a href="http://www.cvshome.org/docs/manual/">there</a>.

    @subsection obtain Obtaining Concepts

    Checking out Concepts from CVS is as simple as this:
    @verbatim setenv CVSROOT /u/users/concepts/cvsroot
 cvs checkout concepts-2 @endverbatim
    When you already have a version of Concepts-2 and want to update
    to the most recent version, just type
    @verbatim cvs update -dP @endverbatim
    in the <tt>concepts-2</tt> subdirectory. This is also a good
    method to find out which files where changed by you (they are
    marked with a "M"). Other marks which could show up are described
    <a href="http://www.loria.fr/~molli/cvs/doc/cvs_16.html#SEC150">here</a>
    and
    <a href="http://www.cvshome.org/docs/manual/cvs_16.html#SEC152">there</a>.

    @subsection commit Giving Back Changes

    When you have changed some files and want to give the changes
    back, you have to "commit" them using the <tt>cvs commit</tt> command:
    @verbatim cvs commit -m "Added anistropic polynomial degree" element.hh @endverbatim
    If you have a somewhat longer comment use <tt>cvs commit</tt>
    without the <tt>-m "message"</tt> and and an editor will be opened
    where you can enter your message.

    If you want to check what your changes where, use
    @verbatim cvs diff -u element.hh @endverbatim
    before using the <tt>commit</tt> command. This will show you the
    changes of your local copy with respect to the current copy in the
    repository.

    You can also check the previous log messages with
    @verbatim cvs log element.hh @endverbatim
    It is good practice to do an update before trying to give back
    changes.

    @subsection reg-cvs Registering New Files

    When you created a new file, then you first need to add this file
    to the repository using
    @verbatim cvs add -m "Abstract base classes for elements" element.hh @endverbatim
    The message is a general description of the file. After this, you
    can commit the new file using the <tt>cvs commit</tt> command.

    Registering a new directory is even easier: it suffices to issue
    the <tt>cvs add</tt> command to create a new directory in the CVS
    repository.

    @section documentation Enhance this Documentation

    The whole documentation is done using
    <a href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</a>. General
    pages are in the \c doc directory, the pages for the tutorials are
    in the \c applications directory: \c file.doxy contains the
    documentation for \c file.cc. The classes are documented right in
    the source files using special Doxygen-style comments.

    To generate the documentation in \c concepts-2/doc/doxygen/html
    use the command
    @verbatim make -C $CONCEPTSDIR doxygen @endverbatim
    and to generate and install the documentation, use
    @verbatim make -C $CONCEPTSDIR html-install DEST=~concepts/www @endverbatim

    @author Philipp Frauenfelder, 2004
*/