Documentation cleanup

This commit is contained in:
Carsten Larsen 2017-01-25 20:34:54 +01:00
parent dafd561bd5
commit 105e780063
12 changed files with 1 additions and 806 deletions

1
.gitignore vendored
View File

@ -8,3 +8,4 @@ amath-test
catalog/flexcat
*.vcxproj.user
.vs
*_.3

View File

@ -1,31 +0,0 @@
.TH "app Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBlib\fP"
.br
.ti -1c
.RI "directory \fBlocalize\fP"
.br
.ti -1c
.RI "directory \fBmain\fP"
.br
.ti -1c
.RI "directory \fBsystem\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBmain\&.cpp\fP"
.br
.in -1c

View File

@ -1,61 +0,0 @@
.TH "app/lib Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app/lib Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBaengine\&.cpp\fP"
.br
.ti -1c
.RI "file \fBaengine\&.h\fP"
.br
.RI "\fIANSI Conole Engine\&. \fP"
.ti -1c
.RI "file \fBcharbuf\&.cpp\fP"
.br
.ti -1c
.RI "file \fBcharbuf\&.h\fP"
.br
.RI "\fIString and character array logic\&. \fP"
.ti -1c
.RI "file \fBcharval\&.h\fP"
.br
.ti -1c
.RI "file \fBcplex\&.cpp\fP"
.br
.ti -1c
.RI "file \fBcplex\&.h\fP"
.br
.RI "\fIClassbased handling of complex numbers\&. \fP"
.ti -1c
.RI "file \fBfgrid\&.cpp\fP"
.br
.ti -1c
.RI "file \fBfgrid\&.h\fP"
.br
.RI "\fIFunction grid used with graphs\&. \fP"
.ti -1c
.RI "file \fBntext\&.cpp\fP"
.br
.ti -1c
.RI "file \fBntext\&.h\fP"
.br
.RI "\fIText to numbers handling\&. \fP"
.ti -1c
.RI "file \fBnumb\&.h\fP"
.br
.RI "\fIClassbase handling of numbers\&. \fP"
.ti -1c
.RI "file \fBreal\&.cpp\fP"
.br
.ti -1c
.RI "file \fBreal\&.h\fP"
.br
.RI "\fIClassbased handling of complex numbers\&. \fP"
.in -1c

View File

@ -1,42 +0,0 @@
.TH "app/localize Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app/localize Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBhelp\&.h\fP"
.br
.RI "\fIHelp texts for statement\&. \fP"
.ti -1c
.RI "file \fBialias\&.h\fP"
.br
.ti -1c
.RI "file \fBident\&.h\fP"
.br
.RI "\fIHelp texts for built-in functions\&. \fP"
.ti -1c
.RI "file \fBkword\&.h\fP"
.br
.RI "\fIKeywords used by lexer\&. \fP"
.ti -1c
.RI "file \fBlex\&.h\fP"
.br
.RI "\fI\fBLexer\fP defitions used by other classes\&. \fP"
.ti -1c
.RI "file \fBstart\&.h\fP"
.br
.RI "\fIStart message and version text\&. \fP"
.ti -1c
.RI "file \fBtags\&.h\fP"
.br
.ti -1c
.RI "file \fBtext\&.h\fP"
.br
.RI "\fIStatic texts in amath\&. \fP"
.in -1c

View File

@ -1,99 +0,0 @@
.TH "app/main Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app/main Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBevaluator\&.cpp\fP"
.br
.ti -1c
.RI "file \fBevaluator\&.h\fP"
.br
.RI "\fITODO: Comment\&. \fP"
.ti -1c
.RI "file \fBfunctiondefs\&.h\fP"
.br
.RI "\fIFunction defitions for math logic\&. \fP"
.ti -1c
.RI "file \fBfunctions\&.cpp\fP"
.br
.ti -1c
.RI "file \fBfunctions\&.h\fP"
.br
.RI "\fIApplication logic tied to functions\&. \fP"
.ti -1c
.RI "file \fBgraphlist\&.cpp\fP"
.br
.ti -1c
.RI "file \fBgraphlist\&.h\fP"
.br
.RI "\fIMemory maintainance for function of graphs\&. \fP"
.ti -1c
.RI "file \fBlexer\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlexer\&.h\fP"
.br
.RI "\fIApplication logic tied to \fBLexer\fP\&. \fP"
.ti -1c
.RI "file \fBnodes\&.cpp\fP"
.br
.ti -1c
.RI "file \fBnodes\&.h\fP"
.br
.RI "\fITop nodes in syntax trees\&. \fP"
.ti -1c
.RI "file \fBoperators\&.cpp\fP"
.br
.ti -1c
.RI "file \fBoperators\&.h\fP"
.br
.RI "\fIApplication logic tied to arithmetic operators\&. \fP"
.ti -1c
.RI "file \fBoptimizer\&.cpp\fP"
.br
.ti -1c
.RI "file \fBoptimizer\&.h\fP"
.br
.ti -1c
.RI "file \fBparser\&.cpp\fP"
.br
.ti -1c
.RI "file \fBparser\&.h\fP"
.br
.RI "\fIApplication logic tied to \fBParser\fP\&. \fP"
.ti -1c
.RI "file \fBstatements\&.cpp\fP"
.br
.ti -1c
.RI "file \fBstatements\&.h\fP"
.br
.RI "\fIGeneral statement nodes\&. \fP"
.ti -1c
.RI "file \fBtoken\&.cpp\fP"
.br
.ti -1c
.RI "file \fBtoken\&.h\fP"
.br
.RI "\fIApplication logic tied to \fBToken\fP\&. \fP"
.ti -1c
.RI "file \fBvalues\&.cpp\fP"
.br
.ti -1c
.RI "file \fBvalues\&.h\fP"
.br
.RI "\fIApplication logic tied to numbers and values\&. \fP"
.ti -1c
.RI "file \fBviewer\&.cpp\fP"
.br
.ti -1c
.RI "file \fBviewer\&.h\fP"
.br
.RI "\fIDebug class to view a syntax tree\&. \fP"
.in -1c

View File

@ -1,169 +0,0 @@
.TH "app/system Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app/system Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBbase\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBconsole\&.cpp\fP"
.br
.ti -1c
.RI "file \fBconsole\&.h\fP"
.br
.RI "\fIGeneric console system calls\&. \fP"
.ti -1c
.RI "file \fBconsole_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBconsole_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBconsole_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBconsole_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBfilesystem\&.h\fP"
.br
.RI "\fIGeneric file system calls\&. \fP"
.ti -1c
.RI "file \fBfilesystem_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBfilesystem_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBfilesystem_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBfilesystem_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBgraph\&.cpp\fP"
.br
.ti -1c
.RI "file \fBgraph\&.h\fP"
.br
.RI "\fILogic related to graph of functions\&. \fP"
.ti -1c
.RI "file \fBgraph_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBgraph_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBgraph_gtk\&.cpp\fP"
.br
.ti -1c
.RI "file \fBgraph_gtk\&.h\fP"
.br
.ti -1c
.RI "file \fBlanguage\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlanguage\&.h\fP"
.br
.ti -1c
.RI "file \fBlanguage_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlanguage_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBlanguage_posix\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlanguage_posix\&.h\fP"
.br
.ti -1c
.RI "file \fBlanguage_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBlanguage_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBpreferences\&.cpp\fP"
.br
.ti -1c
.RI "file \fBpreferences\&.h\fP"
.br
.ti -1c
.RI "file \fBpreferences_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBpreferences_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBpreferences_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBpreferences_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBproc_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBproc_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBprogram\&.cpp\fP"
.br
.ti -1c
.RI "file \fBprogram\&.h\fP"
.br
.RI "\fI\fBProgram\fP flow and global states\&. \fP"
.ti -1c
.RI "file \fBprogram_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBprogram_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBprogram_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBprogram_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBprogram_test\&.cpp\fP"
.br
.ti -1c
.RI "file \fBprogram_test\&.h\fP"
.br
.RI "\fITests for arithmetic logic\&. \fP"
.ti -1c
.RI "file \fBtask\&.h\fP"
.br
.RI "\fIGeneric task/process logic\&. \fP"
.ti -1c
.RI "file \fBtask_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBtask_amiga\&.h\fP"
.br
.ti -1c
.RI "file \fBtask_stdc\&.cpp\fP"
.br
.ti -1c
.RI "file \fBtask_stdc\&.h\fP"
.br
.ti -1c
.RI "file \fBwindow_amiga\&.cpp\fP"
.br
.ti -1c
.RI "file \fBwindow_amiga\&.h\fP"
.br
.in -1c

View File

@ -1,23 +0,0 @@
.TH "app/system/base Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
app/system/base Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBio\&.cpp\fP"
.br
.ti -1c
.RI "file \fBio\&.h\fP"
.br
.RI "\fISystem dependent I/O\&. \fP"
.ti -1c
.RI "file \fBthread\&.h\fP"
.br
.RI "\fIGeneric thread logic\&. \fP"
.in -1c

View File

@ -1,58 +0,0 @@
.TH "lib Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Directories"
.in +1c
.ti -1c
.RI "directory \fBclib\fP"
.br
.ti -1c
.RI "directory \fBcplex\fP"
.br
.ti -1c
.RI "directory \fBdconv\fP"
.br
.ti -1c
.RI "directory \fBreal\fP"
.br
.in -1c
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBclib\&.h\fP"
.br
.RI "\fIC functions for manipulating strings and memory\&. \fP"
.ti -1c
.RI "file \fBcomplex\&.h\fP"
.br
.RI "\fIFunctions in math library for handling complex numbers\&. \fP"
.ti -1c
.RI "file \fBdoc\&.h\fP"
.br
.RI "\fIDocumentation in doxygen format\&. \fP"
.ti -1c
.RI "file \fBdprint\&.h\fP"
.br
.RI "\fIFormat defitions used in the Dragon4 library\&. \fP"
.ti -1c
.RI "file \fBdstandard\&.h\fP"
.br
.RI "\fIType defitions for the Dragon4 library\&. \fP"
.ti -1c
.RI "file \fBmath\&.h\fP"
.br
.RI "\fIFunctions in math library for handling real numbers\&. \fP"
.ti -1c
.RI "file \fBmem\&.h\fP"
.br
.ti -1c
.RI "file \fBplatform\&.h\fP"
.br
.in -1c

View File

@ -1,33 +0,0 @@
.TH "lib/clib Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/clib Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBalloccpy\&.c\fP"
.br
.ti -1c
.RI "file \fBmem\&.c\fP"
.br
.ti -1c
.RI "file \fBmemcpy\&.c\fP"
.br
.ti -1c
.RI "file \fBmemset\&.c\fP"
.br
.ti -1c
.RI "file \fBstrcmp\&.c\fP"
.br
.ti -1c
.RI "file \fBstrlen\&.c\fP"
.br
.ti -1c
.RI "file \fBuntag\&.c\fP"
.br
.in -1c

View File

@ -1,114 +0,0 @@
.TH "lib/cplex Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/cplex Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBcacos\&.c\fP"
.br
.ti -1c
.RI "file \fBcacosh\&.c\fP"
.br
.ti -1c
.RI "file \fBcacot\&.c\fP"
.br
.ti -1c
.RI "file \fBcacoth\&.c\fP"
.br
.ti -1c
.RI "file \fBcacsc\&.c\fP"
.br
.ti -1c
.RI "file \fBcacsch\&.c\fP"
.br
.ti -1c
.RI "file \fBcasec\&.c\fP"
.br
.ti -1c
.RI "file \fBcasech\&.c\fP"
.br
.ti -1c
.RI "file \fBcasin\&.c\fP"
.br
.ti -1c
.RI "file \fBcasinh\&.c\fP"
.br
.ti -1c
.RI "file \fBcatan\&.c\fP"
.br
.ti -1c
.RI "file \fBcatanh\&.c\fP"
.br
.ti -1c
.RI "file \fBccbrt\&.c\fP"
.br
.ti -1c
.RI "file \fBccos\&.c\fP"
.br
.ti -1c
.RI "file \fBccosh\&.c\fP"
.br
.ti -1c
.RI "file \fBccot\&.c\fP"
.br
.ti -1c
.RI "file \fBccoth\&.c\fP"
.br
.ti -1c
.RI "file \fBccsc\&.c\fP"
.br
.ti -1c
.RI "file \fBccsch\&.c\fP"
.br
.ti -1c
.RI "file \fBcexp\&.c\fP"
.br
.ti -1c
.RI "file \fBclog\&.c\fP"
.br
.ti -1c
.RI "file \fBclog10\&.c\fP"
.br
.ti -1c
.RI "file \fBclogb\&.c\fP"
.br
.ti -1c
.RI "file \fBcpow\&.c\fP"
.br
.ti -1c
.RI "file \fBcsec\&.c\fP"
.br
.ti -1c
.RI "file \fBcsech\&.c\fP"
.br
.ti -1c
.RI "file \fBcsgn\&.c\fP"
.br
.ti -1c
.RI "file \fBcsin\&.c\fP"
.br
.ti -1c
.RI "file \fBcsinh\&.c\fP"
.br
.ti -1c
.RI "file \fBcsqrt\&.c\fP"
.br
.ti -1c
.RI "file \fBctan\&.c\fP"
.br
.ti -1c
.RI "file \fBctanh\&.c\fP"
.br
.ti -1c
.RI "file \fBprim\&.c\fP"
.br
.ti -1c
.RI "file \fBprim\&.h\fP"
.br
.in -1c

View File

@ -1,29 +0,0 @@
.TH "lib/dconv Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/dconv Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBdmath\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdmath\&.h\fP"
.br
.RI "\fIMath used in the Dragon4 library\&. \fP"
.ti -1c
.RI "file \fBdprint\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdragon4\&.cpp\fP"
.br
.ti -1c
.RI "file \fBdragon4\&.h\fP"
.br
.RI "\fIConvert floating point format to a decimal number in string format\&. \fP"
.in -1c

View File

@ -1,147 +0,0 @@
.TH "lib/real Directory Reference" 3 "Tue Jan 24 2017" "Version 1.6.2" "amath" \" -*- nroff -*-
.ad l
.nh
.SH NAME
lib/real Directory Reference \-
.SH SYNOPSIS
.br
.PP
.SS "Files"
.in +1c
.ti -1c
.RI "file \fBacos\&.c\fP"
.br
.ti -1c
.RI "file \fBacosh\&.c\fP"
.br
.ti -1c
.RI "file \fBasin\&.c\fP"
.br
.ti -1c
.RI "file \fBasinh\&.c\fP"
.br
.ti -1c
.RI "file \fBatan\&.c\fP"
.br
.ti -1c
.RI "file \fBatan2\&.c\fP"
.br
.ti -1c
.RI "file \fBatanh\&.c\fP"
.br
.ti -1c
.RI "file \fBcbrt\&.c\fP"
.br
.ti -1c
.RI "file \fBceil\&.c\fP"
.br
.ti -1c
.RI "file \fBcopysign\&.c\fP"
.br
.ti -1c
.RI "file \fBcos\&.c\fP"
.br
.ti -1c
.RI "file \fBcosh\&.c\fP"
.br
.ti -1c
.RI "file \fBerf\&.c\fP"
.br
.ti -1c
.RI "file \fBexp\&.c\fP"
.br
.ti -1c
.RI "file \fBexpm1\&.c\fP"
.br
.ti -1c
.RI "file \fBfabs\&.c\fP"
.br
.ti -1c
.RI "file \fBfinite\&.c\fP"
.br
.ti -1c
.RI "file \fBfloor\&.c\fP"
.br
.ti -1c
.RI "file \fBfmod\&.c\fP"
.br
.ti -1c
.RI "file \fBfrexp\&.c\fP"
.br
.ti -1c
.RI "file \fBhypot\&.c\fP"
.br
.ti -1c
.RI "file \fBisnan\&.c\fP"
.br
.ti -1c
.RI "file \fBkcos\&.c\fP"
.br
.ti -1c
.RI "file \fBkremp2\&.c\fP"
.br
.ti -1c
.RI "file \fBksin\&.c\fP"
.br
.ti -1c
.RI "file \fBkstandard\&.c\fP"
.br
.ti -1c
.RI "file \fBktan\&.c\fP"
.br
.ti -1c
.RI "file \fBlog\&.c\fP"
.br
.ti -1c
.RI "file \fBlog10\&.c\fP"
.br
.ti -1c
.RI "file \fBlog1p\&.c\fP"
.br
.ti -1c
.RI "file \fBmatherr\&.c\fP"
.br
.ti -1c
.RI "file \fBmodf\&.c\fP"
.br
.ti -1c
.RI "file \fBnextafter\&.c\fP"
.br
.ti -1c
.RI "file \fBpow\&.c\fP"
.br
.ti -1c
.RI "file \fBprim\&.h\fP"
.br
.ti -1c
.RI "file \fBremp2\&.c\fP"
.br
.ti -1c
.RI "file \fBrint\&.c\fP"
.br
.ti -1c
.RI "file \fBround\&.c\fP"
.br
.ti -1c
.RI "file \fBscalbn\&.c\fP"
.br
.ti -1c
.RI "file \fBsin\&.c\fP"
.br
.ti -1c
.RI "file \fBsinh\&.c\fP"
.br
.ti -1c
.RI "file \fBsqrt\&.c\fP"
.br
.ti -1c
.RI "file \fBtan\&.c\fP"
.br
.ti -1c
.RI "file \fBtanh\&.c\fP"
.br
.ti -1c
.RI "file \fBtrunc\&.c\fP"
.br
.in -1c