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

docs: added section about CMS

parent 94a478c7
No related branches found
No related tags found
No related merge requests found
Classes:
CMS:
This class bundles some features and might be the entry point
of the library in the future. At the moment it doesn't do much.
- Pages are hold by Data, CMS passes trough the call(s).
Data:
This class will handle Data needed by the CMS, provides storage
for modules, manages the database connection and maybe also
......
......@@ -963,6 +963,45 @@ This is the @dfn{Destructor}. It can't fail at runtime, because
In this chapter the important classes are being introduced.
@page
@node CMS
@cindex CMS
@fileindex src/lib/sefht/cms.c
@fileindex src/lib/sefht/cms.h
@section CMS
@dfn{CMS} bundles some features and might be the entry point
of the library in the future. At the moment it doesn't do much.
Definitions are in @file{src/lib/sefht/cms.c}, Declarations in
@file{src/lib/sefht/cms.h}.
@node Using @code{SH_Cms}
@tindex @code{SH_Cms} @sortas{Cms}
@subsection Using @code{SH_Cms}
@deftypefun {SH_Cms *} SH_Cms_new (struct SH_Status * status)
create a new CMS object
The returned pointer must be @code{free}d by passing it to
@code{SH_Cms_free}. On failure @code{NULL} is returned.
The parameter @code{status} must be a valid pointer to a
@code{struct SH_Status} or @code{NULL}. It might be allocated on the
stack. It is updated independently of the occurrence of an error.@*
@xref{Error Handling} for more information about the @code{status}
parameter.
@end deftypefun
@deftypefun void SH_Cms_free (SH_Cms * cms)
free @code{cms}
The parameter @code{cms} must be a valid (non-@code{NULL}) pointer to a
@code{SH_Cms} obtained by a call to @code{SH_Cms_new}. It will be
@code{free}d after the call.
@end deftypefun
@page
@node Logging
@cindex Logging
......
......@@ -36,8 +36,8 @@ 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=455;Make;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2FMakefile.am;0;8
FILE_NAME_7=38112;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fsefht.texi;0;8
FILE_NAME_8=23594;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fcommit_messages.txt;0;8
FILE_NAME_7=38091;None;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fdocs%2Fsefht.texi;0;8
FILE_NAME_8=9;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
FILE_NAME_11=18;C;0;EUTF-8;1;1;0;%2Fhome%2Fjonathan%2FDokumente%2Fprojekte%2Fprgm%2Finternet%2Fweb%2FSeFHT%2Fsrc%2Flib%2Fsefht%2Fcms.h;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