- Small fixes to class documentation

- Now distcheck works correctly, including a copy of the API
documentation in the built dist tar.


git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@214 3ecf2c5c-341e-0410-92b4-d18e462d057c

ChangeLog

@@ -1,3 +1,42 @@
+2006-01-26 21:41  tchernobog
+
+	* trunk/Makefile.am, trunk/doc/Makefile.am, trunk/m4/Makefile.am: -
+	  Fixing makefiles with the help of ``make distcheck''
+
+2006-01-26 20:32  tchernobog
+
+	* trunk/Makefile.am, trunk/config/Doxyfile.in, trunk/configure.ac,
+	  trunk/doc/Makefile.am, trunk/doc/sgpem2uman.texi: - Add support
+	  for automagically generating API documentation with Doxygen. Just
+	  use ``make apidox''.
+
+2006-01-26 18:31  tchernobog
+
+	* trunk/ChangeLog, trunk/configure.ac, trunk/src/Makefile.am,
+	  trunk/src/gtkgui, trunk/src/gtkgui/Makefile.am,
+	  trunk/src/gtkgui/mainwindow.cc, trunk/src/gtkgui/mainwindow.hh,
+	  trunk/src/gtkgui/startgui.cc, trunk/src/gtkgui/startgui.hh,
+	  trunk/src/main.cc, trunk/src/main.hh, trunk/src/pyloader,
+	  trunk/src/pyloader/Makefile.am: - Separate work in a main program
+	  and two libraries. This is experimental, and ideally it should be
+	  a target to work towards decoupling - Still more experimental,
+	  added support for visibility exports from DSOs. Need testing from
+	  someone with GCC 4.0
+
+2006-01-26 14:21  tchernobog
+
+	* trunk/doc/sgpem2dman.texi: - Added norms about documentation
+	  guidelines by Djina - Integrated draft about Mailing List usage
+	  (adaptation)
+
+2006-01-25 17:50  tchernobog
+
+	* trunk/po/POTFILES.in, trunk/src/Makefile.am, trunk/src/main.cc,
+	  trunk/src/parseopts.cc, trunk/src/parseopts.hh: - Added support
+	  for command line option parsing - Creates a vector with filenames
+	  to be opened; not actually useful now, it's already in place when
+	  it'll be needed.
+
 2006-01-24 21:48  tchernobog
 
 	* trunk/doc/sgpem2dman.texi: - Added notes on glib::string,

config/Doxyfile.in

@@ -39,7 +39,7 @@ OUTPUT_DIRECTORY       = @abs_top_builddir@/doc/API/
 # source files, where putting all generated files in the same directory would 
 # otherwise cause performance problems for the file system.
 
-CREATE_SUBDIRS         = YES
+CREATE_SUBDIRS         = NO
 
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all 
 # documentation generated by doxygen is written. Doxygen will use this 
@@ -244,7 +244,7 @@ EXTRACT_STATIC         = NO
 # defined locally in source files will be included in the documentation. 
 # If set to NO only classes defined in header files are included.
 
-EXTRACT_LOCAL_CLASSES  = YES
+EXTRACT_LOCAL_CLASSES  = NO
 
 # This flag is only useful for Objective-C code. When set to YES local 
 # methods, which are defined in the implementation section but not in 
@@ -326,7 +326,7 @@ SORT_MEMBER_DOCS       = YES
 # by member name. If set to NO (the default) the members will appear in 
 # declaration order.
 
-SORT_BRIEF_DOCS        = NO
+SORT_BRIEF_DOCS        = YES
 
 # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be 
 # sorted by fully-qualified names, including namespaces. If set to 

doc/Makefile.am

@@ -32,8 +32,13 @@ if HAVE_DOXYGEN
 	doxygen @top_builddir@/config/Doxyfile
 else
 	@echo "** Doxygen not installed. Skipping generating API docs."
-	test ! -d '$(builddir)/API' && mkdir $(builddir)/API
+	test ! -d './API' && mkdir './API'
 endif
 
-EXTRA_DIST = API
+dist-hook : apidox
-API : apidox
+	cp -Rp './API' '$(distdir)/API'
+
+distclean-local :
+	test -d './API' && rm -rf './API'
+
+MAINTAINERCLEANFILES = API

m4/Makefile.am

@@ -22,9 +22,10 @@
 # aclocaldir = $(datadir)/aclocal
 # better if we don't install our macros...
 # -> aclocal_DATA = ...
-noinst_DATA = compilerflags.m4 \
+macros = compilerflags.m4 \
 	ac_python_devel.m4 \
 	ac_pkg_swig.m4 \
 	ac_python_module.m4
 
-EXTRA_DIST = $(noinst_DATA)
+EXTRA_DIST = $(macros)
+

src/gtkgui/mainwindow.hh

@@ -28,14 +28,13 @@
 
 // ---------------------------------------------
 
-//! The main program window
 class MainWindow;
 
-
 // ---------------------------------------------
 
-
+/** \brief The main program window
-/** This is the main simulation window displayed 
+ * 
+ * This is the main simulation window displayed 
  *  when the program is run with a GUI */
 class MainWindow : public Gtk::Window {
 public:

src/gtkgui/startgui.hh

@@ -23,7 +23,7 @@
 
 #include "config.h"
 
-//! This function starts the whole GUI
+/** \brief This function starts the whole GUI */
 void DLLEXPORT start_gui(int argc, char** argv);
 
 #endif

src/parseopts.hh

@@ -21,8 +21,9 @@
 #ifndef PARSEOPTS_HH
 #define PARSEOPTS_HH 1
 
-//! Parses command line options 
+/** \brief Parses command line options
-/** Parses command line options and sets argv to the first filename 
+ *
+ * Parses command line options and sets argv to the first filename 
  *  given to the cmdline. 
  *  If no filename is given, in the end argc will be 0
  *  Else argc will contain the length of the remaining argv[].
@@ -34,7 +35,7 @@
  */
 void parse_options(int& argc, char**& argv);
 
-//! Prints license notice text to stderr
+/** \brief Prints license notice text to stderr **/
 void print_license();
 
 #endif