[Lemon-commits] [lemon_svn] alpar: r1555 - hugo/trunk/doc

[Lemon SVN]

Author: alpar
Date: Fri Feb 18 11:36:13 2005
New Revision: 1555

Added:
   hugo/trunk/doc/dirs.dox

Log:
Description of the LEMON directories.


Added: hugo/trunk/doc/dirs.dox
==============================================================================
--- (empty file)
+++ hugo/trunk/doc/dirs.dox	Fri Feb 18 11:36:13 2005
@@ -0,0 +1,19 @@
+/**
+\dir lemon
+\brief Base include directory of LEMON
+
+This is the base directory of lemon includes, so each include file must be
+prefixed with this, e.g.
+\code
+#include<lemon/list_graph.h>
+#include<lemon/dijkstra.h>
+\endcode
+*/
+
+/**
+\dir concept
+\brief Concept descriptors and checking classes
+
+This directory contains the concept descriptors and concept checkers. As a user
+you typically don't have to deal with these files.
+*/