Now does full Pozyx class both as class and in groups

pozyxLabs · Jul 19, 2018 · 904fa4e · 904fa4e
1 parent 62578e7
commit 904fa4e
Show file tree

Hide file tree

Showing 14 changed files with 182 additions and 56 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,10 @@
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   pozyx_functions
+   pozyx_class
+   structs
+
+
+
diff --git a/docs/api/pozyx_class.rst b/docs/api/pozyx_class.rst
@@ -0,0 +1,29 @@
+Pozyx Class Full
+================
+
+Members
+-------
+
+.. doxygenclass:: PozyxClass
+    :members:
+
+
+Protected
+---------
+
+.. doxygenclass:: PozyxClass
+    :protected-members:
+
+
+Private
+-------
+
+.. doxygenclass:: PozyxClass
+    :private-members:
+
+
+Undocumented...
+---------------
+
+.. doxygenclass:: PozyxClass
+    :undoc-members:
diff --git a/docs/api/pozyx_functions.rst b/docs/api/pozyx_functions.rst
@@ -0,0 +1,45 @@
+Pozyx Class Full
+================
+
+
+Core
+----
+
+.. doxygengroup:: core
+    :members:
+
+
+System functions
+----------------
+
+.. doxygengroup:: System_functions
+    :members:
+
+
+Communication
+-------------
+
+.. doxygengroup:: Communication_functions
+    :members:
+
+
+Device list
+-------------
+
+.. doxygengroup:: device_list
+    :members:
+
+
+Positioning
+-------------
+
+.. doxygengroup:: Positioning_functions
+    :members:
+
+
+Sensor Data
+-------------
+
+.. doxygengroup:: sensor_data
+    :members:
+
diff --git a/docs/api/structs.rst b/docs/api/structs.rst
diff --git a/docs/doxygen_output/xml/_c_o_n_t_r_i_b_u_t_i_n_g_8md.xml b/docs/doxygen_output/xml/_c_o_n_t_r_i_b_u_t_i_n_g_8md.xml
@@ -0,0 +1,26 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
+  <compounddef id="_c_o_n_t_r_i_b_u_t_i_n_g_8md" kind="file" language="Markdown">
+    <compoundname>CONTRIBUTING.md</compoundname>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+    </detaileddescription>
+    <programlisting>
+<codeline><highlight class="normal">#<sp/>Contributing<sp/>guide</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">For<sp/>now,<sp/>this&apos;ll<sp/>only<sp/>be<sp/>about<sp/>documentation:</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">##<sp/>Generating<sp/>documentation</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">To<sp/>generate<sp/>the<sp/>documentation,<sp/>you&apos;ll<sp/>need<sp/>to<sp/>install<sp/>both<sp/>Doxygen<sp/>and<sp/>Sphinx.<sp/></highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">When<sp/>these<sp/>are<sp/>installed,<sp/>you<sp/>can<sp/>run<sp/>the<sp/>following<sp/>in<sp/>your<sp/>favorite<sp/>shell<sp/>to<sp/>build<sp/>the<sp/>documentation.</highlight></codeline>
+<codeline></codeline>
+<codeline><highlight class="normal">*<sp/>doxygen<sp/>Doxyfile</highlight></codeline>
+<codeline><highlight class="normal">*<sp/>cd<sp/>docs</highlight></codeline>
+<codeline><highlight class="normal">*<sp/>make<sp/>html</highlight></codeline>
+    </programlisting>
+    <location file="CONTRIBUTING.md"/>
+  </compounddef>
+</doxygen>
diff --git a/docs/doxygen_output/xml/_pozyx_8h.xml b/docs/doxygen_output/xml/_pozyx_8h.xml
@@ -9,47 +9,47 @@
     <includedby refid="_pozyx__core_8cpp" local="yes">Pozyx_core.cpp</includedby>
     <includedby refid="_pozyx__lib_8cpp" local="yes">Pozyx_lib.cpp</includedby>
     <incdepgraph>
-      <node id="5">
+      <node id="7">
         <label>assert.h</label>
       </node>
-      <node id="4">
+      <node id="6">
         <label>WProgram.h</label>
       </node>
-      <node id="2">
+      <node id="4">
         <label>Pozyx.h</label>
         <link refid="_pozyx_8h"/>
-        <childnode refid="3" relation="include">
-        </childnode>
-        <childnode refid="4" relation="include">
-        </childnode>
         <childnode refid="5" relation="include">
         </childnode>
         <childnode refid="6" relation="include">
         </childnode>
+        <childnode refid="7" relation="include">
+        </childnode>
+        <childnode refid="8" relation="include">
+        </childnode>
       </node>
-      <node id="6">
+      <node id="8">
         <label>Pozyx_definitions.h</label>
         <link refid="_pozyx__definitions_8h"/>
       </node>
-      <node id="3">
+      <node id="5">
         <label>inttypes.h</label>
       </node>
     </incdepgraph>
     <invincdepgraph>
-      <node id="9">
+      <node id="11">
         <label>Pozyx_lib.cpp</label>
         <link refid="_pozyx__lib_8cpp"/>
       </node>
-      <node id="8">
+      <node id="10">
         <label>Pozyx_core.cpp</label>
         <link refid="_pozyx__core_8cpp"/>
       </node>
-      <node id="7">
+      <node id="9">
         <label>Pozyx.h</label>
         <link refid="_pozyx_8h"/>
-        <childnode refid="8" relation="include">
+        <childnode refid="10" relation="include">
         </childnode>
-        <childnode refid="9" relation="include">
+        <childnode refid="11" relation="include">
         </childnode>
       </node>
     </invincdepgraph>

diff --git a/docs/doxygen_output/xml/_pozyx__core_8cpp.xml b/docs/doxygen_output/xml/_pozyx__core_8cpp.xml
@@ -6,42 +6,42 @@
     <includes local="no">Wire.h</includes>
     <includes refid="_pozyx__definitions_8h" local="yes">Pozyx_definitions.h</includes>
     <incdepgraph>
-      <node id="14">
+      <node id="16">
         <label>assert.h</label>
       </node>
-      <node id="10">
+      <node id="12">
         <label>Pozyx_core.cpp</label>
         <link refid="_pozyx__core_8cpp"/>
-        <childnode refid="11" relation="include">
+        <childnode refid="13" relation="include">
         </childnode>
-        <childnode refid="16" relation="include">
+        <childnode refid="18" relation="include">
         </childnode>
-        <childnode refid="15" relation="include">
+        <childnode refid="17" relation="include">
         </childnode>
       </node>
-      <node id="13">
+      <node id="15">
         <label>WProgram.h</label>
       </node>
-      <node id="16">
+      <node id="18">
         <label>Wire.h</label>
       </node>
-      <node id="11">
+      <node id="13">
         <label>Pozyx.h</label>
         <link refid="_pozyx_8h"/>
-        <childnode refid="12" relation="include">
-        </childnode>
-        <childnode refid="13" relation="include">
-        </childnode>
         <childnode refid="14" relation="include">
         </childnode>
         <childnode refid="15" relation="include">
         </childnode>
+        <childnode refid="16" relation="include">
+        </childnode>
+        <childnode refid="17" relation="include">
+        </childnode>
       </node>
-      <node id="15">
+      <node id="17">
         <label>Pozyx_definitions.h</label>
         <link refid="_pozyx__definitions_8h"/>
       </node>
-      <node id="12">
+      <node id="14">
         <label>inttypes.h</label>
       </node>
     </incdepgraph>

diff --git a/docs/doxygen_output/xml/_pozyx__definitions_8h.xml b/docs/doxygen_output/xml/_pozyx__definitions_8h.xml
@@ -6,30 +6,30 @@
     <includedby refid="_pozyx__core_8cpp" local="yes">Pozyx_core.cpp</includedby>
     <includedby refid="_pozyx__lib_8cpp" local="yes">Pozyx_lib.cpp</includedby>
     <invincdepgraph>
-      <node id="22">
+      <node id="24">
         <label>Pozyx_lib.cpp</label>
         <link refid="_pozyx__lib_8cpp"/>
       </node>
-      <node id="21">
+      <node id="23">
         <label>Pozyx_core.cpp</label>
         <link refid="_pozyx__core_8cpp"/>
       </node>
-      <node id="20">
+      <node id="22">
         <label>Pozyx.h</label>
         <link refid="_pozyx_8h"/>
-        <childnode refid="21" relation="include">
+        <childnode refid="23" relation="include">
         </childnode>
-        <childnode refid="22" relation="include">
+        <childnode refid="24" relation="include">
         </childnode>
       </node>
-      <node id="19">
+      <node id="21">
         <label>Pozyx_definitions.h</label>
         <link refid="_pozyx__definitions_8h"/>
-        <childnode refid="20" relation="include">
+        <childnode refid="22" relation="include">
         </childnode>
-        <childnode refid="21" relation="include">
+        <childnode refid="23" relation="include">
         </childnode>
-        <childnode refid="22" relation="include">
+        <childnode refid="24" relation="include">
         </childnode>
       </node>
     </invincdepgraph>

diff --git a/docs/doxygen_output/xml/_pozyx__lib_8cpp.xml b/docs/doxygen_output/xml/_pozyx__lib_8cpp.xml
@@ -6,42 +6,42 @@
     <includes local="no">Wire.h</includes>
     <includes refid="_pozyx__definitions_8h" local="yes">Pozyx_definitions.h</includes>
     <incdepgraph>
-      <node id="23">
+      <node id="25">
         <label>Pozyx_lib.cpp</label>
         <link refid="_pozyx__lib_8cpp"/>
-        <childnode refid="24" relation="include">
+        <childnode refid="26" relation="include">
         </childnode>
-        <childnode refid="29" relation="include">
+        <childnode refid="31" relation="include">
         </childnode>
-        <childnode refid="28" relation="include">
+        <childnode refid="30" relation="include">
         </childnode>
       </node>
-      <node id="27">
+      <node id="29">
         <label>assert.h</label>
       </node>
-      <node id="26">
+      <node id="28">
         <label>WProgram.h</label>
       </node>
-      <node id="29">
+      <node id="31">
         <label>Wire.h</label>
       </node>
-      <node id="24">
+      <node id="26">
         <label>Pozyx.h</label>
         <link refid="_pozyx_8h"/>
-        <childnode refid="25" relation="include">
-        </childnode>
-        <childnode refid="26" relation="include">
-        </childnode>
         <childnode refid="27" relation="include">
         </childnode>
         <childnode refid="28" relation="include">
         </childnode>
+        <childnode refid="29" relation="include">
+        </childnode>
+        <childnode refid="30" relation="include">
+        </childnode>
       </node>
-      <node id="28">
+      <node id="30">
         <label>Pozyx_definitions.h</label>
         <link refid="_pozyx__definitions_8h"/>
       </node>
-      <node id="25">
+      <node id="27">
         <label>inttypes.h</label>
       </node>
     </incdepgraph>

diff --git a/docs/doxygen_output/xml/class_pozyx_class.xml b/docs/doxygen_output/xml/class_pozyx_class.xml
@@ -6611,7 +6611,7 @@ Please read the tutorial Ready to Localize to learn how to use this function.</p
     <briefdescription>
     </briefdescription>
     <detaileddescription>
-<para>Provides an interface to an attached Pozyx shield </para>    </detaileddescription>
+<para>Provides an interface to an attached Pozyx shield. </para>    </detaileddescription>
     <location file="Pozyx.h" line="236" column="1" bodyfile="Pozyx.h" bodystart="235" bodyend="1864"/>
     <listofallmembers>
       <member refid="class_pozyx_class_1a97fd77c200c18cff08ec2d13144c0bad" prot="protected" virt="non-virtual"><scope>PozyxClass</scope><name>_fw_version</name></member>

diff --git a/docs/doxygen_output/xml/index.xml b/docs/doxygen_output/xml/index.xml
@@ -123,6 +123,8 @@
   </compound>
   <compound refid="changelog_8md" kind="file"><name>changelog.md</name>
   </compound>
+  <compound refid="_c_o_n_t_r_i_b_u_t_i_n_g_8md" kind="file"><name>CONTRIBUTING.md</name>
+  </compound>
   <compound refid="_pozyx_8h" kind="file"><name>Pozyx.h</name>
     <member refid="_pozyx_8h_1a070d2ce7b6bb7e5c05602aa8c308d0c4" kind="define"><name>NULL</name></member>
     <member refid="_pozyx_8h_1ad6d5aaa966ca7424f7cb9bd01f2c838b" kind="define"><name>assert</name></member>
@@ -482,6 +484,8 @@
   </compound>
   <compound refid="md_changelog" kind="page"><name>md_changelog</name>
   </compound>
+  <compound refid="md__c_o_n_t_r_i_b_u_t_i_n_g" kind="page"><name>md_CONTRIBUTING</name>
+  </compound>
   <compound refid="md__r_e_a_d_m_e" kind="page"><name>md_README</name>
   </compound>
 </doxygenindex>
diff --git a/docs/doxygen_output/xml/md__c_o_n_t_r_i_b_u_t_i_n_g.xml b/docs/doxygen_output/xml/md__c_o_n_t_r_i_b_u_t_i_n_g.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8' standalone='no'?>
+<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
+  <compounddef id="md__c_o_n_t_r_i_b_u_t_i_n_g" kind="page">
+    <compoundname>md_CONTRIBUTING</compoundname>
+    <title>Contributing guide</title>
+    <briefdescription>
+    </briefdescription>
+    <detaileddescription>
+<para>For now, this&apos;ll only be about documentation:</para><para><heading level="2">Generating documentation</heading>
+</para><para>To generate the documentation, you&apos;ll need to install both Doxygen and Sphinx.</para><para>When these are installed, you can run the following in your favorite shell to build the documentation.</para><para><itemizedlist>
+<listitem><para>doxygen Doxyfile</para></listitem><listitem><para>cd docs</para></listitem><listitem><para>make html </para></listitem></itemizedlist>
+</para>    </detaileddescription>
+  </compounddef>
+</doxygen>
diff --git a/docs/general/index.rst b/docs/general/index.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,7 +10,5 @@ Welcome to Pozyx Arduino Library's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-
-
-.. doxygenclass:: PozyxClass
-    :members:
+   api/index
+