Skip to content

Commit c30babe

Browse files
committed
Layout, textual, syntactical changes documentation
Some layout, textual, syntactical changes in the documentation - extsearch.doc better left and right ceil (so they span the total vertical part of the formula - htmldcmds.doc, xmlcmds.doc, Doxyfile Correction of the positioning in the "HTML Command" / "XML Command" filed as the command was positioned properly at the top resulting in more required space for the table. Solution based on: https://tex.stackexchange.com/questions/376373/hyperref-inserts-vertical-space-in-tabular-cell
1 parent 80dadfd commit c30babe

File tree

6 files changed

+124
-123
lines changed

6 files changed

+124
-123
lines changed

doc/Doxyfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,8 @@ HTML_EXTRA_FILES += translator_report.txt
5656
ALIASES = LaTeX="\f({\LaTeX}\f)"
5757
ALIASES += TeX="\f({\TeX}\f)"
5858
ALIASES += forceNewPage="\latexonly \newpage \endlatexonly"
59+
ALIASES += startalign=" \latexonly\noalign{\endlatexonly"
60+
ALIASES += endalign=" \latexonly}\endlatexonly"
5961
LATEX_BATCHMODE = YES
6062
LATEX_EXTRA_STYLESHEET = manual.sty
6163
LATEX_EMOJI_DIRECTORY = ../doc

doc/commands.doc

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -902,10 +902,8 @@ Structural indicators
902902
\addindex \\name
903903

904904
This command turns a comment block into a header
905-
definition of a member group. The
906-
comment block should be followed by a
907-
<code>///\@{ ... ///\@}</code> block containing the
908-
members of the group.
905+
definition of a member group. The comment block should be followed by a
906+
`@{` ... `@}` block containing the members of the group.
909907

910908
See section \ref memgroup for an example.
911909

@@ -2076,7 +2074,7 @@ void setPosition(double x,double y,double z,double t)
20762074
for an example.
20772075

20782076
<hr>
2079-
\section cmdxrefitem \\xrefitem <key> "(heading)" "(list title)" { text }
2077+
\section cmdxrefitem \\xrefitem <key> "heading" "list title" { text }
20802078

20812079
\addindex \\xrefitem
20822080
This command is a generalization of commands such as \ref cmdtodo "\\todo"
@@ -2091,7 +2089,8 @@ void setPosition(double x,double y,double z,double t)
20912089
is a quoted string representing the heading of the section under which
20922090
text passed as the fourth argument is put. The third argument (list title)
20932091
is used as the title for the related page containing all items with the
2094-
same key. The keys \c "todo", \c "test", \c "bug" and \c "deprecated" are predefined.
2092+
same key. The second and third string argument cannot contain a newline.
2093+
The keys \c "todo", \c "test", \c "bug" and \c "deprecated" are predefined.
20952094

20962095
To get an idea on how to use the \c \\xrefitem command and what its effect
20972096
is, consider the todo list, which (for English output) can be seen an

doc/extsearch.doc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ The fields have the following meaning:
278278
- *first*: the index of first result returned: \f$\min(n*p,\mbox{\em hits})\f$.
279279
- *count*: the actual number of results returned: \f$\min(n,\mbox{\em hits}-\mbox{\em first})\f$
280280
- *page*: the page number of the result: \f$p\f$
281-
- *pages*: the total number of pages: \f$\lceil\frac{\mbox{\em hits}}{n}\rceil\f$.
281+
- *pages*: the total number of pages: \f$\left\lceil\frac{\mbox{\em hits}}{n}\right\rceil\f$.
282282
- *items*: an array containing the search data per result.
283283

284284
Here is an example of how the element of the *items* array should look like:

0 commit comments

Comments
 (0)