DOC: CHANGELOG and documentation generation.

CHANGELOG.md

@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added ###
 
+- Full functionality of libcaosdb mapped to Octave / Matlab.
+
 ## [0.0.1] - 2021-08-12 ##
 
 ### Added ###

doc/Development.rst

+===========
 Development
 ===========
 
 Structure
----------
+=========
 
 The sources for functions and classes are in ``src/``.  Private functions (mostly C++ source files
-which are to be compiled into ``*.mex``) are implemented in ``private/_some_function.*``.
-
-
+which are to be compiled into ``*.mex``) are implemented in
+``private/maox_some_function.*``. (``maox`` stands for "mex file for CaosDB".
 
 Writing Documentation
----------------------
+=====================
 
-- Example for texinfo documentation:
-  https://github.com/gnu-octave/octave/blob/default/scripts/geometry/inpolygon.m
+- The first string after the copyright block is used for documentation.  This implies that the
+  copyright block must be recognized as such: A copyright line should be the first line there.
+- Documentation should be written as TexInfo (see below for details) in order to be available in the
+  online documentation.
 - Extract documentation from file:
   ``[txt, form] = get_help_text_from_file(make_absolute_filename('pkg/inst/some_function.m'))``
 - Generate HTML documentation from single file:
@@ -29,3 +31,15 @@ Writing Documentation
     .. code-block:: octave
 
        generate_package_html('caosdb', 'htdocs', 'octave-forge')
+
+TexInfo details
+---------------
+
+Here is an Example for texinfo documentation:..
+  https://github.com/gnu-octave/octave/blob/default/scripts/geometry/inpolygon.m
+
+Useful TexInfo commands:
+
+- ``@deftypefn`` ::
+    Define a function that can be called.  Example code:..
+    ``@deftypefn{Function File} {@var{out} =} caosdb_exec (@var{arg})``

src/caosdb_exec.m

-% This file is a part of the CaosDB Project.
-%
 % Copyright (C) 2021 IndiScale GmbH <info@indiscale.com>
 % Copyright (C) 2021 Daniel Hornung <d.hornung@indiscale.com>
 %
+% This file is a part of the CaosDB Project.
+%
 % This program is free software: you can redistribute it and/or modify
 % it under the terms of the GNU Affero General Public License as
 % published by the Free Software Foundation, either version 3 of the
@@ -19,7 +19,7 @@
 % -*- texinfo -*-
 % @deftypefn {Function File} {@var{out} =} caosdb_exec (arg)
 % @cindex index term
-% Calls the equivalkent of the @code{caosdb} command line interface executable.  Mostly, this can
+% Calls the equivalent of the @code{caosdb} command line interface executable.  Mostly, this can
 % output the version of libcaosdb.
 %
 % Typical arguments are @code{"--version"} or @code{"--test-connection"}.