diff options
| author | Jan Dittberner <jandd@cacert.org> | 2018-10-28 19:22:32 +0100 |
|---|---|---|
| committer | Jan Dittberner <jandd@cacert.org> | 2018-10-28 19:25:06 +0100 |
| commit | cff7cc67797d3b2a7ab03c6bf2b726d5725f26cd (patch) | |
| tree | f51f20447c655dbd05873bcc27ae2443825e7496 /source/general.rst | |
| parent | e2045ba3c673588d80923e734d311e2a1b5b424a (diff) | |
| download | cacert-codedocs-cff7cc67797d3b2a7ab03c6bf2b726d5725f26cd.tar.gz cacert-codedocs-cff7cc67797d3b2a7ab03c6bf2b726d5725f26cd.tar.xz cacert-codedocs-cff7cc67797d3b2a7ab03c6bf2b726d5725f26cd.zip | |
Start documenting CommModule
- add a file meant to collect general observations
- add a file meant to collect information related to the database schema
- add a glossary file
- add documentation for the CommModule files in source/directories.rst
- start signer protocol specification in source/signer.rst
- add support for block and sequence diagrams via sphinxcontrib-blockdiag and
sphinxcontrib-seqdiag
Diffstat (limited to 'source/general.rst')
| -rw-r--r-- | source/general.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/source/general.rst b/source/general.rst new file mode 100644 index 0000000..908a017 --- /dev/null +++ b/source/general.rst @@ -0,0 +1,26 @@ +==================== +General observations +==================== + +License +======= + +The code is licensed under the terms of the GPL version 2 upgrading to GPL 3 +would require consent from all former contributors. Copyright years of files +have not been consistently incremented/updated on changes. + +Languages +========= + +The code base is a mix of Perl, Shell and PHP code. Most of the code is +implemented in PHP. + +Code structure +============== + +Comments and inline documentation +================================= + +The code base is not documented in a good way, there are neither class nor +method or function comments. Comments are just used for the license header +in most of the files.
\ No newline at end of file |