pdf to epub c# : Display bookmarks in pdf control Library platform web page asp.net windows web browser doxygen11-part1707

21.108 \f]
108
21.108 \f]
Markstheendofalongformulathatisdisplayedcenteredonaseparateline.
Seealso:
section\f[andsectionformulas.
21.109 \htmlonly
StartsablockoftextthatwillbeverbatimincludedinthegeneratedHTMLdocumentationonly.Theblock
endswithaendhtmlonlycommand.
ThiscommandcanbeusedtoincludeHTMLcodethatistoocomplexfordoxygen(i.e. applets,java-
scripts,andHTMLtagsthatrequireattributes). Youcanusethe\latexonlyand\endlatexonlypairto
provideaproperLAT
E
Xalternative.
Note:environmentvariables(like$(HOME))areresolvedinsideaHTML-onlyblock.
Seealso:
section\manonlyandsection\latexonly.
21.110 \image<format><file>[”caption”][<sizeindication>=<size>]
Insertsanimageintothedocumentation. Thiscommandisformatspecific,soifyouwanttoinsertan
imageformorethanoneformatyou’llhavetorepeatthiscommandforeachformat.
Thefirstargumentspecifiestheoutputformat. Currently,thefollowingvaluesaresupported:htmland
latex.
The second argument specifies the file name of the image. doxygen will look forfiles in the paths (orfiles)
that you specified after theIMAGE
PATHtag.Iftheimageisfounditwillbecopiedtothecorrectoutput
directory. If the image name contains spaces you’ll have to put quotes (”) around it. You can also specify
an absolute URL instead ofa file name,but then doxygen does not copy the image norcheck its existance.
The third argument is optional and can be used to specify the caption that is displayed below the image.
This argumenthas to be specifiedona single lineandbetweenquotes evenifitdoes notcontainanyspaces.
The quotes are stripped before the caption is displayed.
The fourth argument is also optional and can be used to specify the width or height of the image. This
is only useful for LAT
E
Xoutput (i.e. format=latex). The sizeindication can be either width or
height. The sizeshould bea valid size specifierin LAT
E
X(forexample 10cm or6in ora symbolic width
like \textwidth).
Here is example of a comment block:
/
*
! Here is a snapshot of my new application:
*
\image html application.jpg
*
\image latex application.eps "My application" width=10cm
*
/
And this is an example ofhow the relevant part ofthe configuration file may look:
IMAGE_PATH
= my_image_dir
Warning:
The image format for HTML is limited to what your browser supports. For LAT
E
X, the image format
must be Encapsulated PostScript (eps).
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
Display bookmarks in pdf - add, remove, update PDF bookmarks in C#.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your C# Project with Rapid PDF Internal Navigation Via Bookmark and Outline
bookmarks pdf file; create pdf bookmark
Display bookmarks in pdf - VB.NET PDF bookmark library: add, remove, update PDF bookmarks in vb.net, ASP.NET, MVC, Ajax, WinForms, WPF
Empower Your VB.NET Project with Rapid PDF Internal Navigation Via Bookmark and Outline
how to bookmark a pdf in reader; pdf bookmark editor
21.111 \latexonly
109
Doxygen does not check if the image is in the correct format. So you have to make sure this is the
case!
21.111 \latexonly
Starts a block of text that will be verbatim included in the generated L
A
T
E
Xdocumentation only. The block
ends with a endlatexonly command.
This command can be used to include LAT
E
Xcode that is too complex for doxygen (i.e. images, formu-
las, special characters). You can use the \htmlonly and \endhtmlonly pair to provide a proper HTML
alternative.
Note: environment variables (like $(HOME)) are resolved inside a LAT
E
X-onlyblock.
See also:
section\latexonly and section\htmlonly.
21.112 \manonly
Starts a block of text that will be verbatimincluded in the generated MAN documentation only. The block
ends with a endmanonly command.
This commandcan be used to include groff code directly into MAN pages. You can use the \htmlonly and
\latexonly and \endhtmlonly and \endlatexonly pairs to provide proper HTML and L
A
T
E
Xalternatives.
See also:
section\htmlonly and section\latexonly.
21.113 \li { item-description }
This commandhas one argumentthat continues until the first blank line oruntil another \li is encountered.
The command can be used to generate a simple, not nested list of arguments. Each argument should start
with a \li command.
Example:
Typing:
\li \c AlignLeft left alignment.
\li \c AlignCenter center alignment.
\li \c AlignRight right alignment
No other types of alignment are supported.
will result in the following text:
• AlignLeft left alignment.
• AlignCenter center alignment.
• AlignRight right alignment
No other types of alignment are supported.
Note:
For nested lists, HTML commands should be used.
Equivalent to\arg
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
.NET PDF SDK - Description of All PDF Processing Control Feastures
PDF Viewer in HTML5; Outstanding rendering of PDF documents; Full page navigation, zooming & rotation; Outlines, bookmarks, & thumbnail display; Integrated text
copy bookmarks from one pdf to another; create bookmarks pdf
XDoc.Word for .NET, Advanced .NET Word Processing Features
& rotation; Outlines, bookmarks, & thumbnail display; Integrated annotation; More about Web Viewer ▶. Conversion. Word Create. Create Word from PDF; Create Word
adding bookmarks to pdf document; bookmark page in pdf
21.114 \n
110
21.114 \n
Forces a new line. Equivalent to <br>and inspired by the printf function.
21.115 \p <word>
Displays the parameter <word> using a typewriter font. You can use this command to refer to member
function parameters in the running text.
Example:
... the \p x and \p y coordinates are used to ...
This will result in the following text:
... the x and y coordinates are used to ...
Equivalent to\c
21.116 \verbatim
Starts a block of text that will be verbatim included in both the HTML and the LAT
E
Xdocumentation. The
block should end with a \endverbatimblock. All commands are disabled in a verbatim block.
Warning:
Make sure you include a \endverbatim command for each \verbatim command or the parser will get
confused!
See also:
section\code, and section\verbinclude.
21.117 \xmlonly
Starts a block of text that will be verbatim included in the generated XML output only. The block ends
with a endxmlonly command.
This command can be used to include custom XML tags.
See also:
section\htmlonly and section\latexonly.
21.118 \\
This command writes a backslash character (\) to the HTML and L
A
T
E
Xoutput. The backslash has to be
escaped in some cases because doxygen uses it to detect commands.
21.119 \@
This command writes an at-sign (@)tothe HTML andL
A
T
E
Xoutput. The at-signhas tobe escaped in some
cases because doxygen uses it to detect JavaDoc commands.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
XDoc.PowerPoint for .NET, All Mature Features Introductions
& rotation; Outlines, bookmarks, & thumbnail display; Integrated annotation; More about Web Viewer ▶. PowerPoint Convert. Convert PowerPoint to PDF; Convert
create pdf bookmarks online; export pdf bookmarks to text
XDoc.Excel for .NET, Comprehensive .NET Excel Imaging Features
zooming & rotation; Outlines, bookmarks, & thumbnail display; Integrated annotation; More about Web Viewer ▶. Excel Convert. Convert Excel to PDF; Convert Excel
create bookmarks in pdf reader; adding bookmarks to a pdf
21.120 \∼[LanguageId]
111
21.120 \∼[LanguageId]
This command enables/disables a language specific filter. This can be used to put documentation for
differentlanguage intoone commentblock anduse the OUTPUT
LANGUAGE tagtofilteroutonly aspecific
language. Use \∼language
id to enable output for a specific language only and \∼to enable output for all
languages (this is also the default mode).
Example:
/
*
! \˜english This is english \˜dutch Dit is Nederlands \˜german Dieses ist
deutsch. \˜ output for all languages.
*
/
21.121 \&
This command writes the & character to output. This character has to be escaped because it has a special
meaning in HTML.
21.122 \$
This command writes the$ characterto the output. This characterhas to beescapedin some cases,because
it is used to expand environment variables.
21.123 \#
This command writes the# characterto the output. This characterhas to beescapedin some cases,because
it is used to refer to documented entities.
21.124 <
This command writes the < character to the output. This character has to be escaped because it has a
special meaning in HTML.
21.125 >
This command writes the > character to the output. This character has to be escaped because it has a
special meaning in HTML.
21.126 \%
This commandwritesthe% charactertotheoutput. This characterhas tobeescapedinsome cases,because
it is used to prevent auto-linking to word that is also a documented class orstruct.
21.127 PHP only commands
ForPHP files there are a number of additional commands, that can be used inside classes to make members
public, private, or protected even though the language itself doesn’t support this notion.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
C# PDF Convert to HTML SDK: Convert PDF to html files in C#.net
SDK, preserves all the original anchors, links, bookmarks and font This C#.NET PDF to HTML conversion library can browser when it is trying to display a PDF
convert word to pdf with bookmarks; bookmarks in pdf files
C# powerpoint - Convert PowerPoint to HTML in C#.NET
to HTML converter toolkit SDK, preserves all the original anchors, links, bookmarks and font issue of web browser when it is trying to display a PowerPoint
split pdf by bookmark; export pdf bookmarks to text file
112
To mark a single item use one of \private, \protected, \public. For starting a section with a certain protec-
tion level use one of: \privatesection, \protectedsection, \publicsection. The latter commands are similar
to ”private:”, ”protected:”, and ”public:” in C++.
Commands included for Qt compatibility
The following commands are supported to remain compatible to the Qt class browser generator. Do not
use these commands in your own documentation.
• \annotatedclasslist
• \classhierarchy
• \define
• \functionindex
• \header
• \headerfilelist
• \inherit
• \l
• \postheader
22 HTML Commands
Here is a list of all HTML commands that may be used inside the documentation. Note that although these
HTML tags are translated to the proper commands for outer formats other than HTML, all attributes of a
HTML tag are passed on to the HTML output only (the HREF and NAME attributes for the A tag are the
only exception).
• <A HREF="..."> Starts a HTML hyper-link (HTML only).
• <A NAME="..."> Starts an named anchor(HTML only).
• </A> Ends a link or anchor (HTML only).
• <B>Starts a piece of text displayed in a bold font.
• </B> Ends a <B>section.
• <BODY> Does not generate any output.
• </BODY> Does not generate any output.
• <BR> Forces a line break.
• <CENTER> starts a section of centered text.
• </CENTER> ends a section of centered text.
• <CAPTION> Starts a caption. Use within a table only.
• </CAPTION> Ends a caption. Use within a table only.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
C# Word - Convert Word to HTML in C#.NET
VB.NET How-to, VB.NET PDF, VB.NET Word, VB SDK, preserves all the original anchors, links, bookmarks and font of web browser when it is trying to display a Word
how to add bookmark in pdf; add bookmarks pdf
C# Excel - Convert Excel to HTML in C#.NET
to HTML converter toolkit SDK, preserves all the original anchors, links, bookmarks and font crashing issue of web browser when it is trying to display a Excel
how to bookmark a pdf file; bookmark template pdf
113
• <CODE> Starts a piece oftext displayed in a typewriter font. Note that for C# code, this command
is equivalent to\code.
• </CODE> End a <CODE>section. Note that forC#code,this commandis equivalent to\endcode.
• <DD> Starts an item description.
• <DFN> Starts a piece of text displayed in a typewriterfont.
• </DFN> Ends a <DFN> section.
• <DIV> Starts a section with a specific style (HTML only)
• </DIV> Ends a section with a specific style (HTML only)
• <DL> Starts a description list.
• </DL> Ends a description list.
• <DT> Starts an item title.
• </DT> Ends an item title.
• <EM> Starts a piece of text displayed in anitalic font.
• </EM> Ends a <EM> section.
• <FORM> Does not generate any output.
• </FORM> Does not generate any output.
• <HR> Writes a horizontal ruler.
• <H1> Starts an unnumbered section.
• </H1> Ends an unnumberd section.
• <H2> Starts an unnumbered subsection.
• </H2> Ends an unnumbered subsection.
• <H3> Starts an unnumbered subsubsection.
• </H3> Ends an unnumbered subsubsection.
• <I>Starts a piece of text displayed in anitalic font.
• <INPUT> Does not generate any output.
• </I> Ends a <I>section.
• <IMG> This command is written with attributes to the HTML output only.
• <LI> Starts a new list item.
• </LI> Ends a list item.
• <META> Does not generate any output.
• <MULTICOL> ignored by doxygen.
• </MUTLICOL> ignored by doxygen.
• <OL> Starts a numbered itemlist.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
114
• </OL> Ends a numbered item list.
• <P>Starts a new paragraph.
• </P> Ends a paragraph.
• <PRE> Starts a preformatted fragment.
• </PRE> Ends a preformatted fragment.
• <SMALL> Starts a section of text displayedin a smaller font.
• </SMALL> Ends a <SMALL> section.
• <SPAN> Starts an inline text fragment with a specific style (HTML only)
• </SPAN> Ends an inline text fragment with a specific style (HTML only)
• <STRONG> Starts a section of bold text.
• </STRONG> Ends a section ofbold text.
• <SUB> Starts a piece of text displayed in subscript.
• </SUB> Ends a <SUB> section.
• <SUP> Starts a piece of text displayed in superscript.
• </SUP> Ends a </SUP> section.
• <TABLE> starts a table.
• </TABLE> ends a table.
• <TD> Starts a new table data element.
• </TD> Ends a table data element.
• <TR> Starts a new table row.
• </TR> Ends a table row.
• <TT> Starts a piece of text displayed in a typewriterfont.
• </TT> Ends a <TT> section.
• <KBD> Starts a piece of text displayed in a typewriterfont.
• </KBD> Ends a <KBD> section.
• <UL> Starts an unnumbered itemlist.
• </UL> Ends an unnumbered item list.
• <VAR> Starts a piece of text displayed in an italic font.
• </VAR> Ends a </VAR> section.
The special HTML character entities that are recognized by Doxygen:
• &copy; the copyright symbol
• &tm; the trade mark symbol
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
115
• &reg; the registered trade mark symbol
• &lt; less-than symbol
• &gt; greater-than symbol
• &amp; ampersand
• &apos; single quotation mark (straight)
• &quot; double quotation mark (straight)
• &lsquo; left single quotation mark
• &rsquo; right single quotation mark
• &ldquo; left double quotation mark
• &rdquo; right double quotation mark
• &ndash; n-dash (fornumeric ranges,eg. 2–8)
• &mdash; m-dash (for parenthetical punctuation — like this)
• &?uml; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a diaeresis accent (like
¨a).
• &?acute; where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, writes a character with a acute accent (like
´a).
• &?grave; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a grave accent (like
`
a).
• &?circ; where ? is one of {A,E,I,O,U,a,e,i,o,u,y}, writes a character with a circumflex accent
(like ˆa).
• &?tilde; where ? is one of {A,N,O,a,n,o}, writes a character with a tilde accent (like ˜a).
• &szlig; write a sharp s (i.e. ß) to the output.
• &?cedil; where ? is one of {c,C},writes a c-cedille (like c¸).
• &?ring; where ? is one of {a,A}, writes an a with a ring (like ˚a).
• &nbsp; a non breakable space.
Finally,to put invisible comments inside comment blocks, HTML style comments can be used:
/
*
! <!-- This is a comment with a comment block --> Visible text
*
/
23 XML Commands
Doxygen supports most of the XML commands that are typically used in C# code comments. The XML
tags are defined inAppendix E oftheECMA-334 standard, which defines the C# language. Unfortunately,
the specification is not very precise and a number of the examples given are ofpoor quality.
Here is the list of tags supported by doxygen:
• <c> Identifies inline text that should be rendered as a piece of code. Similar to using
<tt>text</tt>.
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
116
• <code> Set one or more lines of source code or program output. Note that this command
behaves like \code ...
\endcode for C# code, but it behaves like the HTML equivalent
<code>...</code>forother languages.
• <description> Part of a <list> command, describes anitem.
• <example> Marks a block of text as an example,ignored by doxygen.
• <exception cref="member"> Identifies the exception a method can throw.
• <include> Can be used to import a piece of XML from an external file. Ignored by doxygen at
the moment.
• <item> List item. Can only be used inside a <list>context.
• <list type="type"> Starts a list, supported types are bullet or number and table. A
listconsists of a numberof<item>tags. Alist of type table,is a two column table which canhave
aheader.
• <listheader> Starts the header of a list oftype ”table”.
• <para> Identifies a paragraphof text.
• <param name="paramName"> Marks a piece of text as the documentation for parameter
”paramName”. Similar to using\param .
• <paramref name="paramName"> Refers to a parameter with name ”paramName”. Similar
to using\a.
• <permission> Identifies the security accessibility of a member. Ignored by doygen.
• <remarks> Identifies the detailed description.
• <returns> Marks a piece of text as the return value of a function or method. Similar to using
\return.
• <see cref="member"> Refers to a member. Similar to\ref.
• <seealso cref="member"> Starts a ”See also” section referring to ”member”. Similar to
using\samember.
• <summary> Identifies the brief description. Similar to using\brief.
• <term> Part of a <list> command.
• <value> Identifies a property. Ignored by doxygen.
Here is an example of a typical piece of code using some ofthe above commands:
/// <summary>
/// A search engine.
/// </summary>
class Engine
{
/// <summary>
/// The Search method takes a series of parameters to specify the search criterion
/// and returns a dataset containing the result set.
/// </summary>
/// <param name="connectionString">the connection string to connect to the
/// database holding the content to search</param>
/// <param name="maxRows">The maximum number of rows to
/// return in the result set</param>
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
117
/// <param name="searchString">The text that we are searching for</param>
/// <returns>A DataSet instance containing the matching rows. It contains a maximum
/// number of rows specified by the maxRows parameter</returns>
public DataSet Search(string connectionString, int maxRows, int searchString)
{
DataSet ds = new DataSet();
return ds;
}
}
Part III
Developers Manual
24 Doxygen’s Internals
Doxygen’s internals Note that this section is still under construction!
The following picture shows how source files are processed by doxygen.
Config parser
Language parser
C Preprocessor
HTML
LaTeX
RTF
XML
input
string
entry
tree
input files
Man
config file
drives
drives
get settings
entry
tree
drives
drives
tag file parser
Doc Parser
Source Parser
Data organiser
Output generators
drives
Figure 2: Data flow overview
The following sections explain the steps above in more detail.
Config parser The configuration file that controls the settings of a project is parsed and the settings are
storedin the singleton class Config in src/config.h. The parser itselfis written using flex and can
User ManualforDoxygen1.5.3,written byDimitrivanHeesch
c
1997-2006
Documents you may be interested
Documents you may be interested