Merge pull request #1783 from verilog-to-routing/clb_and_atom_netlist_docs

MohamedElgammal · web-flow · commit 387b8253cc7c · 2021-06-21T13:10:32.000+02:00
Add doxygen documentation of atom_netlist and clb_netlist to vpr API …
diff --git a/doc/src/api/vpr/netlist.rst b/doc/src/api/vpr/netlist.rst
@@ -1,14 +1,37 @@
-=======
+========
+Netlists
+========
+
 Netlist
-=======
+-------
 
 .. doxygenfile:: netlist.h
    :project: vpr
    :sections: detaileddescription
 
-Classes
--------
 
 .. doxygenclass:: Netlist
    :project: vpr
    :members:
+
+Clustered  Netlist
+------------------
+
+.. doxygenfile:: clustered_netlist.h
+   :project: vpr
+   :sections: detaileddescription
+
+.. doxygenclass:: ClusteredNetlist 
+   :project: vpr
+   :members:
+
+Atom Netlist
+------------
+
+.. doxygenfile:: atom_netlist.h
+   :project: vpr
+   :sections: detaileddescription
+
+.. doxygenclass:: AtomNetlist
+    :project: vpr
+    :members:
