Changeset dcf46c in git

Timestamp:

Jun 20, 2014, 4:58:14 PM (10 years ago)

Author:

Oleksandr Motsak <motsak@…>

Branches:

(u'fieker-DuVal', '117eb8c30fc9e991c4decca4832b1d19036c4c65')(u'spielwiese', 'fc741b6502fd8a97288eaa3eba6e5220f3c3df87')

Children:

c7356b63ff773598fb6bd4a02eaca0893d2031e6

Parents:

be22fb785a1c1cd8f506d9c6fd983e526123ae87

git-author:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-06-20 16:58:14+02:00

git-committer:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-06-20 17:59:38+02:00

Message:

Fixed the deps. between doxy pages

Files:

• Makefile.am (modified) (1 diff)
• Singular/countedref.h (modified) (2 diffs)
• Singular/dyn_modules/dyn_modules.dox (modified) (1 diff)
• main.dox (modified) (2 diffs)

Makefile.am

@@ -10 +10 @@
 dox emacs debian redhat desktop
 
-EXTRA_DIST = README autogen.sh git-version-gen doxy
+EXTRA_DIST = README.md autogen.sh git-version-gen doxy
 
 bin_SCRIPTS = libsingular-config

Singular/countedref.h

@@ -1 @@
-/// -*- c++ -*-
+// -*- c++ -*-
 //*****************************************************************************
 /** @file countedref.h
- *
- * @author Alexander Dreyer
- * @date 2012-08-15
  *
  * This file defines reusable classes supporting reference counted interpreter
@@ -11 +8 @@
  *
  * @note This works was supported by the "Industrial Algebra" project.
+ *
+ * @author Alexander Dreyer
+ * @date 2012-08-15
  *
  * @par Copyright:

Singular/dyn_modules/dyn_modules.dox

@@ -5 +5 @@
  and also define new data structures (like \ref libpolys_page).
  
- - \subpage bigintm
- - \subpage syzextra
- - \subpage pyobject
- - \subpage callgfanlib
- - \subpage callpolymake
- - \subpage singmathic
+ - \subpage dynmodules_bigintm_page
+ - \subpage dynmodules_syzextra_page
+ - \subpage dynmodules_pyobject_page
+ - \subpage dynmodules_callgfanlib_page
+ - \subpage dynmodules_callpolymake_page
+ - \subpage dynmodules_singmathic_page
 */

main.dox

@@ -1 @@
-/*! \page main_page Developer and Reference Manual
+/*! \page main_page Introductory developers manual
 
-Somewhat older kernel documentation can be found at
-<ftp://www.mathematik.uni-kl.de/pub/Math/Singular/doc/singular-anatomy.tgz>
+The Singular kernel development introduction contains:
 
-Please also read 
-- \subpage bs_page and 
-- \ref styleguide
+- \subpage styleguide "the C/C++ programming Style Guide",
+- \subpage bs_page "the Singular build system",
+- somewhat outdated Singular kernel documentation: <ftp://www.mathematik.uni-kl.de/pub/Math/Singular/doc/singular-anatomy.tgz>,
+- a short description of the Singular restructurization: <http://www.singular.uni-kl.de/gap-meeting-2012/SW.Aug.12.motsak.2.pdf> and
+- the current internal structure and dependencies can be seen at \subpage deps_page. 
+  Top-level packages are:
+  - \subpage omalloc_page "Singular Memory Manager"
+  - \subpage resources_page "Resource Handling Helpers"
+  - \subpage factory_page "Factorization lib." 
+  - \subpage libpolys_page "Singular most basic data structures"
+  - \subpage kernel_page "Mathematical Algorithms"
+  - \subpage singular_page "Singular Interpreter and related"
+  
+*/
 
-Separate top-level packages are as follows (also see the diagram below):
-- \subpage omalloc_page 
-- \subpage resources_page 
-- \subpage factory_page 
-- \subpage libpolys_page 
-  - \subpage libpolys_misc_page
-  - \subpage libpolys_reporter_page
-  - \subpage libpolys_coeffs_page
-  - \subpage libpolys_polys_page
-- \subpage kernel_page 
-  - \subpage kernel_numeric_page
-  - \subpage kernel_combinatorics_page
-  - \subpage kernel_GBEngine_page
-  - \subpage kernel_groebner_walk_page
-  - \subpage kernel_fglm_page
-  - \subpage kernel_maps_page
-  - \subpage kernel_spectrum_page
-  - \subpage kernel_linear_algebra_page
-  - \subpage kernel_oswrapper_page
-- \subpage singular_page
-  - \subpage dynmodules_page
+/*!
+\page deps_page Dependencies between Singular packages
 
-Here is a short description of the Singular restructurization:
-<http://www.singular.uni-kl.de/gap-meeting-2012/SW.Aug.12.motsak.2.pdf>
+- \ref omalloc_page 
+- \ref resources_page 
+- \ref factory_page 
+- \ref libpolys_page 
+  - \ref libpolys_misc_page
+  - \ref libpolys_reporter_page
+  - \ref libpolys_coeffs_page
+  - \ref libpolys_polys_page
+- \ref kernel_page 
+  - \ref kernel_numeric_page
+  - \ref kernel_combinatorics_page
+  - \ref kernel_GBEngine_page
+  - \ref kernel_groebner_walk_page
+  - \ref kernel_fglm_page
+  - \ref kernel_maps_page
+  - \ref kernel_spectrum_page
+  - \ref kernel_linear_algebra_page
+  - \ref kernel_oswrapper_page
+- \ref singular_page
+  - \ref dynmodules_page
 
-Dependencies between Singular packages are as follows:
+
+Dependencies between Singular packages (and sub-grouppings) are shown as arrows on the following diagramm:
 \dotfile Includes.dot Package dependency diagram
-
 */
 
@@ -46 +55 @@
 configure scripts): 
 
-- \subpage omalloc_page 
-- \subpage resources_page
-- \subpage factory_page 
-- \subpage libpolys_page 
-- \subpage singular_page
+- \ref omalloc_page 
+- \ref resources_page
+- \ref factory_page 
+- \ref libpolys_page 
+- \ref singular_page
 
 Moreover some of these (top-level) libraries combine smaller ones into
 itself. 
-- \subpage libpolys_page 
-  - \subpage libpolys_misc_page
-  - \subpage libpolys_reporter_page
-  - \subpage libpolys_coeffs_page
-  - \subpage libpolys_polys_page
-- \subpage singular_page
-  - \subpage kernel_page 
-  - \subpage dynmodules_page
+- \ref libpolys_page 
+  - \ref libpolys_misc_page
+  - \ref libpolys_reporter_page
+  - \ref libpolys_coeffs_page
+  - \ref libpolys_polys_page
+- \ref singular_page
+  - \ref kernel_page 
+  - \ref dynmodules_page