Changeset 175eb21 in git

Timestamp:

Jun 2, 2014, 8:11:45 PM (9 years ago)

Author:

Oleksandr Motsak <motsak@…>

Branches:

(u'spielwiese', '8e0ad00ce244dfd0756200662572aef8402f13d5')

Children:

ee121df974c1705dca6d334a16b69f52ee5fc0d4f2f858ca222de40e7ba6575dfb35d4c07798b475

Parents:

9dfd5ce1f10c58069c2cbf71a531c2ab399447dd

git-author:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-06-02 20:11:45+02:00

git-committer:

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

Message:

All of necessary doxygen desc. stubs

Files:

• Singular/singular.dox (modified) (1 diff)
• kernel/GBEngine/GBEngine.dox (added)
• kernel/combinatorics/combinatorics.dox (modified) (1 diff)
• kernel/fglm/fglm.dox (added)
• kernel/groebner_walk/groebner_walk.dox (added)
• kernel/kernel.dox (modified) (1 diff)
• kernel/linear_algebra/linear_algebra.dox (added)
• kernel/maps/maps.dox (added)
• kernel/numeric/numeric.dox (modified) (1 diff)
• kernel/oswrapper/oswrapper.dox (added)
• kernel/spectrum/spectrum.dox (added)
• libpolys/misc/misc.dox (added)
• libpolys/polys/polys.dox (added)
• libpolys/reporter/reporter.dox (added)
• omalloc/omalloc.dox (added)
• resources/resources.dox (added)

Singular/singular.dox

@@ -1 @@
-/*! \page singular_page Interpreter(Singular)
+/*! \page singular_page Singular Interpreter and related functionality
  *
  * Iterpreter and wrappers over kernel (\ref kernel_page)
  * 
+ * Singular can be easily extended by means of dynamic modules:
  * \subpage dynmodules_page
+ *
+ * TODO: The sub-package structure is not yet defined for Singular package...
  */

kernel/combinatorics/combinatorics.dox

@@ -1 @@
-/*! \page kernel_sample_page Sample Kernel Sub-Package
+/*! \page kernel_combinatorics_page "Combinatorical algorithms"
  *
- * Serves as an example/template for separation of further sub-packages from within kerrnel (\ref kernel_page)
+ * This sub-package of kernel (\ref kernel_page) contains
+ * combinatorical algorithms. 
+ *
+ * TODO: list those algorithms... and corresponding interpreter functions...?
  * 
- * <A HREF="https://github.com/Singular/Sources/wiki/Todo">TODOs</A>
  */
+

kernel/kernel.dox

@@ -4 +4 @@
  * 
  * The files in kernel/ directory are combined into a internal library
- * kernelCommon, which contains the functions and data that are shared
-among the following sub-packages:
+ * kernelCommon, which contains the functions (e.g. \ref rChangeCurrRing)
+ * and data members (e.g. \ref currRing) 
+ * that can be shared among the following sub-packages:
  *
  * \subpage kernel_numeric_page

kernel/numeric/numeric.dox

@@ -1 @@
-/*! \page kernel_numeric_page "Numeric Kernel Sub-Package"
+/*! \page kernel_numeric_page "Numeric algorithms"
  *
- * Sub-package of kernel (\ref kernel_page) with numerical algorithms
+ * This sub-package of kernel (\ref kernel_page) contains
+ * numerical algorithms. 
+ *
+ * TODO: list those algorithms... and corresponding interpreter functions...?
  * 
- * <A HREF="https://github.com/Singular/Sources/wiki/Todo">TODOs</A>
  */