From c546894fc6c2af3ff81789893a5fb816c697ab73 Mon Sep 17 00:00:00 2001 From: albert-github Date: Mon, 13 Aug 2018 12:18:25 +0200 Subject: Small corrections in distributed man pages --- doc/doxygen.1 | 4 ++-- doc/doxyindexer.1 | 2 +- doc/doxysearch.1 | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/doxygen.1 b/doc/doxygen.1 index 1deb7b6..5ac287e 100644 --- a/doc/doxygen.1 +++ b/doc/doxygen.1 @@ -3,7 +3,7 @@ doxygen \- documentation system for various programming languages .SH DESCRIPTION Doxygen is a documentation system for C++, C, Java, Objective-C, IDL -(Corba and Microsoft flavors) and to some extent PHP, C#, and D. +(Corba and Microsoft flavors), Fortran, Python, VHDL and to some extent PHP, C#, and D. .PP You can use doxygen in a number of ways: .TP @@ -25,7 +25,7 @@ If - is used for configName doxygen will read from standard input. .TP 4) Use doxygen to generate a template file controlling the layout of the generated documentation: .IP -doxygen -l layoutFileName.xml +doxygen -l [layoutFileName.xml] .TP 5) Use doxygen to generate a template style sheet file for RTF, HTML or Latex. .TP diff --git a/doc/doxyindexer.1 b/doc/doxyindexer.1 index ae4b282..b0d46d0 100644 --- a/doc/doxyindexer.1 +++ b/doc/doxyindexer.1 @@ -3,7 +3,7 @@ doxyindexer \- creates a search index from raw search data .SH SYNOPSIS .B doxyindexer -[\fI-o output_dir\fR] \fIsearchdata.xml \fR[\fIsearchdata2.xml\fR...] ] +[\fI-o output_dir\fR] \fIsearchdata.xml \fR[\fIsearchdata2.xml\fR...] .SH DESCRIPTION Generates a search index called \fBdoxysearch.db\fR from one or more search data files produced by doxygen. Use diff --git a/doc/doxysearch.1 b/doc/doxysearch.1 index a00124f..a26107b 100644 --- a/doc/doxysearch.1 +++ b/doc/doxysearch.1 @@ -2,10 +2,10 @@ .SH NAME doxysearch.cgi \- search engine used for searching in doxygen documentation. .SH SYNOPSIS -.B doxyindexer.cgi +.B doxysearch.cgi .SH DESCRIPTION CGI binary that is used by doxygen generated HTML output to search for words. The tool uses the search index called \fBdoxysearch.db\fR produced by doxyindexer. .SH SEE ALSO -doxygen(1), doxysearch(1), doxywizard(1). +doxygen(1), doxyindexer(1), doxywizard(1). -- cgit v0.12 From cbb0ae9a02305e0464737b316abd35e8e6d7c1a2 Mon Sep 17 00:00:00 2001 From: "Charles.Lee" Date: Mon, 20 Aug 2018 01:27:27 +0900 Subject: Bug fix for plantuml # What is the problem - The following plantuml is not processed. ``` /** * @brief Clear the rule. * @startuml * participant CReceiver * opt MsgFromSender() * alt cmd=IGN_STATUS_IN && value == 0 * alt * CReceiver ->> CHmi : Draw_HMI sendMsg() -> sendMessage(HMI,MSGIDN,...) * else * note right CReceiver : Draw Directly * end * else * note right CReceiver : mbBlockDraw = false * end * end * @enduml */ ``` # debugging method - change into DOT_CLEANUP = NO in Doxyfile to remain the plantuml file for debugging. - the following context is result of remaining plantuml file. ``` @startuml participant CReceiver opt MsgFromSender() alt cmd=IGN_STATUS_IN && value == 0 alt CReceiver ->> CHmi : Draw_HMI sendMsg() -> sendMessage(HMI,MSGIDN,...) else note right CReceiver : Draw Directly end else note right CReceiver : mbBlockDraw = false end end@enduml ``` # Solution - add return in front of @enduml --- src/plantuml.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/plantuml.cpp b/src/plantuml.cpp index 89e6e9e..ada035b 100644 --- a/src/plantuml.cpp +++ b/src/plantuml.cpp @@ -47,7 +47,7 @@ QCString writePlantUMLSource(const QCString &outDir,const QCString &fileName,con } QCString text = "@startuml\n"; text+=content; - text+="@enduml\n"; + text+="\n@enduml\n"; file.writeBlock( text, text.length() ); file.close(); return baseName; -- cgit v0.12 From 731758537f45b602b000cb081d8b642fc54141da Mon Sep 17 00:00:00 2001 From: albert-github Date: Sun, 19 Aug 2018 19:45:00 +0200 Subject: Documentation correction include command with options - Corrected syntax - made text consistent --- doc/commands.doc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/commands.doc b/doc/commands.doc index 2e51d79..a630aac 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2157,7 +2157,7 @@ Commands for displaying examples \ref cmdinclude "\\include".

-\section cmdinclude[{lineno|doc}] \\include +\section cmdinclude \\include[{lineno|doc}] \addindex \\include This command can be used to include a source file as a block of code. @@ -2210,8 +2210,8 @@ Commands for displaying examples \section cmdincludelineno \\includelineno \addindex \\includelineno - This command works the same way as \ref cmdinclude "\\include", but will add line - numbers to the included file. + This command is obsolete and is still supported for backward compatibility reasons, + it works the same way as \ref cmdinclude "\\include{lineno}" \sa sections \ref cmdinclude "\\include{lineno}". @@ -2222,7 +2222,7 @@ Commands for displaying examples This command is obsolete and is still supported for backward compatibility reasons, it works the same way as \ref cmdinclude "\\include{doc}" - \sa section \ref cmdinclude "\\include". + \sa section \ref cmdinclude "\\include{doc}".
\section cmdline \\line ( pattern ) -- cgit v0.12 From 5b11346a3620a0788bd0b9106c159e2f1e6356df Mon Sep 17 00:00:00 2001 From: albert-github Date: Tue, 21 Aug 2018 19:32:27 +0200 Subject: Truncated split bar in HTML output between treeview and normal text area In case of of choosing small letters in the browser or having a large display one can see that the split bar ends at a certain point. --- templates/html/navtree.css | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/html/navtree.css b/templates/html/navtree.css index 7d1cb67..81c54c2 100644 --- a/templates/html/navtree.css +++ b/templates/html/navtree.css @@ -96,7 +96,7 @@ .ui-resizable-e { background-image:url("splitbar.png"); background-size:100%; - background-repeat:no-repeat; + background-repeat:repeat-y; background-attachment: scroll; cursor:ew-resize; height:100%; -- cgit v0.12