Added some info on how we can add images to the documentation
This commit is contained in:
@@ -15,6 +15,17 @@ You need to have installed the program from either the Git\+Hub page or website,
|
||||
\begin{DoxyItemize}
|
||||
\item Please make sure the internal names (\char`\"{}tags\char`\"{}) of files are using \char`\"{}camel\+Case\char`\"{}
|
||||
\begin{DoxyItemize}
|
||||
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name/tag used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
|
||||
\item Example\+: for \char`\"{}@page documentation\+Guide Documentation Guide\char`\"{} \char`\"{}documentation\+Guide\char`\"{} is the name/tag used internally by doxygen. \char`\"{}\+Documentation Guide\char`\"{} is what shows up on the output documentation.
|
||||
\end{DoxyItemize}
|
||||
\end{DoxyItemize}
|
||||
\end{DoxyItemize}\hypertarget{documentation_guide_autotoc_md23}{}\doxysubsection{Adding Images}\label{documentation_guide_autotoc_md23}
|
||||
Use this pattern/format\+:
|
||||
\begin{DoxyCode}{0}
|
||||
\DoxyCodeLine{@image html "{}Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg"{}}
|
||||
\DoxyCodeLine{@cond EXCLUDED}
|
||||
\DoxyCodeLine{}
|
||||
\DoxyCodeLine{@endcond}
|
||||
|
||||
\end{DoxyCode}
|
||||
|
||||
|
||||
Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.
|
||||
Reference in New Issue
Block a user