Skip to content
Snippets Groups Projects
Commit 16ae753e authored by Jonathan Schöbel's avatar Jonathan Schöbel
Browse files

docs: added some markup

parent 25d8fdac
No related branches found
No related tags found
No related merge requests found
......@@ -64,9 +64,9 @@ found in @ref{History}.
@node About
@section About
The Server side Fragment based Homepage Toolkit (SeFHT) is a library,
with which the frontend of websites can be generated. It can be used
from any C (and C++) program
The @dfn{Server side Fragment based Homepage Toolkit} (SeFHT) is a
library, with which the frontend of websites can be generated. It can
be used from any C (and C++) program
(and from other languages, if the bindings exist).
It does not provide any network related features, so it might end up
in a CGI program, or for some ambitious project in a module for a
......@@ -266,21 +266,22 @@ Autoconf, Automake and Libtool. Documentation is created using
GNU Texinfo. The used testing framework is check.
For static code analysis splint is used, but not very actively.
The project implements a library and a small demo program (sefht_demo),
The project implements a library and a small demo program
(@command{sefht_demo}),
which uses some base functionality of the library.
@subsection Compilation
For compiling and linking libtool is used, this way the correct flags
for both static and dynamic linking are added depending on the platform.
This can be configured using configure.
This can be configured using @command{configure}.
When compiling against libsefht, only the central header file
(sefht/sefht.h) should be included. It takes care of including other
header files in the right order.
(@file{sefht/sefht.h}) should be included. It takes care of including
other header files in the right order.
To prevent accidental inclusion, there are header inclusion guards.
To disable these inclusion guards, the macro SEFHT_COMPILATION is
To disable these inclusion guards, the macro @env{SEFHT_COMPILATION} is
defined. If another program does this, then it can be depended on the
internals, which is discouraged.
This macro is also defined for compiling the tests, as they also test a
......@@ -296,8 +297,7 @@ internal state.
@subsection Compilation flags
As there are some wrapper functions, inlining across compilation units
is desired, so link time optimization is turned on. (-flto)
is desired, so link time optimization is turned on. (@option{-flto}).
@node Index
@unnumbered Index
......
......@@ -36,7 +36,7 @@ FILE_NAME_3=84;Make;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fp
FILE_NAME_4=73;Make;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fsrc%2FMakefile.am;0;8
FILE_NAME_5=19;C;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fsrc%2Fmain.c;0;8
FILE_NAME_6=85;Make;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2FMakefile.am;0;8
FILE_NAME_7=5722;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fsefht.texi;0;8
FILE_NAME_7=13428;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fsefht.texi;0;8
FILE_NAME_8=3883;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fcommit_messages.txt;0;8
FILE_NAME_9=1867;Make;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fsrc%2Flib%2FMakefile.am;0;8
FILE_NAME_10=18;C;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fsrc%2Flib%2Fsefht%2Fcms.c;0;8
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment