diff --git a/Documentation/html/Funny-Cat-Hidden.jpg b/Documentation/html/Funny-Cat-Hidden.jpg new file mode 100644 index 0000000..65f8e8b Binary files /dev/null and b/Documentation/html/Funny-Cat-Hidden.jpg differ diff --git a/Documentation/html/_9_hardware_8markdown.html b/Documentation/html/_9_hardware_8markdown.html index 3bd2b9f..ea8ea88 100644 --- a/Documentation/html/_9_hardware_8markdown.html +++ b/Documentation/html/_9_hardware_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_hardware_8markdown.html',''); initR diff --git a/Documentation/html/_9_software_8markdown.html b/Documentation/html/_9_software_8markdown.html index 8ee4db6..1cd5425 100644 --- a/Documentation/html/_9_software_8markdown.html +++ b/Documentation/html/_9_software_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_9_software_8markdown.html',''); initR diff --git a/Documentation/html/_design_01_choices_8markdown.html b/Documentation/html/_design_01_choices_8markdown.html index ed0c4ba..80689e8 100644 --- a/Documentation/html/_design_01_choices_8markdown.html +++ b/Documentation/html/_design_01_choices_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_design_01_choices_8markdown.html','') diff --git a/Documentation/html/_device_01_specifications_8markdown.html b/Documentation/html/_device_01_specifications_8markdown.html index 070bd21..f8b1024 100644 --- a/Documentation/html/_device_01_specifications_8markdown.html +++ b/Documentation/html/_device_01_specifications_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_device_01_specifications_8markdown.ht diff --git a/Documentation/html/_documentation_01_guide_8markdown.html b/Documentation/html/_documentation_01_guide_8markdown.html index 1f19de1..d128319 100644 --- a/Documentation/html/_documentation_01_guide_8markdown.html +++ b/Documentation/html/_documentation_01_guide_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_documentation_01_guide_8markdown.html diff --git a/Documentation/html/_r_e_a_d_m_e_8markdown.html b/Documentation/html/_r_e_a_d_m_e_8markdown.html index 9e5f310..4904ced 100644 --- a/Documentation/html/_r_e_a_d_m_e_8markdown.html +++ b/Documentation/html/_r_e_a_d_m_e_8markdown.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('_r_e_a_d_m_e_8markdown.html',''); init diff --git a/Documentation/html/design_choices.html b/Documentation/html/design_choices.html index ca13363..165c0c5 100644 --- a/Documentation/html/design_choices.html +++ b/Documentation/html/design_choices.html @@ -142,7 +142,7 @@ Microcontroller Peripheral Connections diff --git a/Documentation/html/device_specifications.html b/Documentation/html/device_specifications.html index 5db1bdf..41ccfc3 100644 --- a/Documentation/html/device_specifications.html +++ b/Documentation/html/device_specifications.html @@ -237,7 +237,7 @@ Inertial Measurement Unit: TDK InvenSense ICM-20600 diff --git a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html index e453213..05578b1 100644 --- a/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html +++ b/Documentation/html/dir_4e9c05acfa2c3671b8618fcb95d57d96.html @@ -104,7 +104,7 @@ Directories diff --git a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html index 0a193fe..c7dac43 100644 --- a/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html +++ b/Documentation/html/dir_6cc751a9e685a986d41d35de353de328.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_6cc751a9e685a986d41d35de353de328.h diff --git a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html index 822ab0e..1d79d84 100644 --- a/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html +++ b/Documentation/html/dir_70428d3c5958c16802133545478a5cfb.html @@ -104,7 +104,7 @@ Directories diff --git a/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html index 968a267..2e4cbc6 100644 --- a/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html +++ b/Documentation/html/dir_7795a02a4813dcd036f04e5f7854f185.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('dir_7795a02a4813dcd036f04e5f7854f185.h diff --git a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html index 215cca8..e94ec4a 100644 --- a/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html +++ b/Documentation/html/dir_ef94255a62432ae865475b379d8bd501.html @@ -104,7 +104,7 @@ Files diff --git a/Documentation/html/documentation_guide.html b/Documentation/html/documentation_guide.html index 11bd9bb..29ace23 100644 --- a/Documentation/html/documentation_guide.html +++ b/Documentation/html/documentation_guide.html @@ -111,17 +111,24 @@ Important Notes For Consistency +

+Adding Images

+

Use this pattern/format:

@image html "Documentation Guide.assets/Funny-Cat-Hidden.jpg"
+
@cond EXCLUDED
+
![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg)
+
@endcond
+

Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors.

diff --git a/Documentation/html/files.html b/Documentation/html/files.html index c5ee801..499b74b 100644 --- a/Documentation/html/files.html +++ b/Documentation/html/files.html @@ -107,7 +107,7 @@ $(document).ready(function(){initNavTree('files.html',''); initResizable(); }); diff --git a/Documentation/html/globals.html b/Documentation/html/globals.html index 16da22d..85803f7 100644 --- a/Documentation/html/globals.html +++ b/Documentation/html/globals.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('globals.html',''); initResizable(); }) diff --git a/Documentation/html/globals_func.html b/Documentation/html/globals_func.html index ba55a21..095f42b 100644 --- a/Documentation/html/globals_func.html +++ b/Documentation/html/globals_func.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable( diff --git a/Documentation/html/hardware.html b/Documentation/html/hardware.html index 2f32775..57f4396 100644 --- a/Documentation/html/hardware.html +++ b/Documentation/html/hardware.html @@ -118,7 +118,7 @@ Design Reminders diff --git a/Documentation/html/index.html b/Documentation/html/index.html index eb8fafc..27af132 100644 --- a/Documentation/html/index.html +++ b/Documentation/html/index.html @@ -140,7 +140,7 @@ TODO List diff --git a/Documentation/html/main_8c.html b/Documentation/html/main_8c.html index fd8d3b9..920ba04 100644 --- a/Documentation/html/main_8c.html +++ b/Documentation/html/main_8c.html @@ -131,7 +131,7 @@ Functions diff --git a/Documentation/html/main_8c_source.html b/Documentation/html/main_8c_source.html index bf761ff..f7677e6 100644 --- a/Documentation/html/main_8c_source.html +++ b/Documentation/html/main_8c_source.html @@ -108,7 +108,7 @@ $(document).ready(function(){initNavTree('main_8c_source.html',''); initResizabl diff --git a/Documentation/html/navtreedata.js b/Documentation/html/navtreedata.js index 0cb5aa6..3f07dbf 100644 --- a/Documentation/html/navtreedata.js +++ b/Documentation/html/navtreedata.js @@ -39,7 +39,8 @@ var NAVTREE = [ "Doxygen", "documentation_guide.html#autotoc_md19", null ], [ "Updating Documentation", "documentation_guide.html#autotoc_md20", null ], [ "Important Notes", "documentation_guide.html#autotoc_md21", [ - [ "For Consistency", "documentation_guide.html#autotoc_md22", null ] + [ "For Consistency", "documentation_guide.html#autotoc_md22", null ], + [ "Adding Images", "documentation_guide.html#autotoc_md23", null ] ] ] ] ], [ "Files", "files.html", [ diff --git a/Documentation/html/navtreeindex0.js b/Documentation/html/navtreeindex0.js index d61398e..f3bf9d6 100644 --- a/Documentation/html/navtreeindex0.js +++ b/Documentation/html/navtreeindex0.js @@ -24,6 +24,7 @@ var NAVTREEINDEX0 = "documentation_guide.html#autotoc_md20":[3,1], "documentation_guide.html#autotoc_md21":[3,2], "documentation_guide.html#autotoc_md22":[3,2,0], +"documentation_guide.html#autotoc_md23":[3,2,1], "files.html":[4,0], "globals.html":[4,1,0], "globals_func.html":[4,1,1], diff --git a/Documentation/html/pages.html b/Documentation/html/pages.html index 08edd37..482781b 100644 --- a/Documentation/html/pages.html +++ b/Documentation/html/pages.html @@ -106,7 +106,7 @@ $(document).ready(function(){initNavTree('pages.html',''); initResizable(); }); diff --git a/Documentation/html/software.html b/Documentation/html/software.html index 6f4b93d..4f82d34 100644 --- a/Documentation/html/software.html +++ b/Documentation/html/software.html @@ -98,7 +98,7 @@ $(document).ready(function(){initNavTree('software.html',''); initResizable(); } diff --git a/Documentation/latex/documentation_guide.tex b/Documentation/latex/documentation_guide.tex index 948b6c1..14582a0 100644 --- a/Documentation/latex/documentation_guide.tex +++ b/Documentation/latex/documentation_guide.tex @@ -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} \ No newline at end of file +\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{![img](Documentation Guide.assets/Funny-\/Cat-\/Hidden.jpg)} +\DoxyCodeLine{@endcond} + +\end{DoxyCode} + + +Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors. \ No newline at end of file diff --git a/Hardware/!Hardware.markdown b/Hardware/!Hardware.markdown index 21e02a1..b4ef26a 100644 --- a/Hardware/!Hardware.markdown +++ b/Hardware/!Hardware.markdown @@ -16,4 +16,4 @@ - Keep the trace between the device and the crystal as short as possible. - Design a good ground plane around the oscillator pins. - Prevent crosstalk from other clock or data lines into oscillator pins XIN and XOUT. - - Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins. \ No newline at end of file + - Avoid running PCB traces underneath or adjacent to the XIN and XOUT pins. diff --git a/Meta/Documentation Guide.assets/Funny-Cat-Hidden.jpg b/Meta/Documentation Guide.assets/Funny-Cat-Hidden.jpg new file mode 100644 index 0000000..65f8e8b Binary files /dev/null and b/Meta/Documentation Guide.assets/Funny-Cat-Hidden.jpg differ diff --git a/Meta/Documentation Guide.markdown b/Meta/Documentation Guide.markdown index 7e7c738..b1d45bb 100644 --- a/Meta/Documentation Guide.markdown +++ b/Meta/Documentation Guide.markdown @@ -33,3 +33,18 @@ You need to have installed the program from either the GitHub page or website, t "documentationGuide" is the name/tag used internally by doxygen. "Documentation Guide" is what shows up on the output documentation. +## Adding Images + +Use this pattern/format: +@code +@image html "Documentation Guide.assets/Funny-Cat-Hidden.jpg" +@cond EXCLUDED +![img](Documentation Guide.assets/Funny-Cat-Hidden.jpg) +@endcond +@endcode + +Which will output a single image that is both easily viewable in Doxygen, as well as Markdown viewers/editors. + +@cond EXCLUDED +**Note: if you are reading this in a Markdown/text editor, do not include the '@code' and '@endcode' lines! Those are just to present it nicely for those reading in Doxygen pages. Please also switch to view the source code view if not already, that way you can see the code for the Markdown image.** +@endcond \ No newline at end of file