Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some overview to the RRGraphView doxygen documentation #2745

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
+246 −174
Open

Add some overview to the RRGraphView doxygen documentation #2745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
46d8927
add rr graph view annotation
treelin611 Sep 24, 2024
54a56d5
checked
treelin611 Sep 24, 2024
a3e4c4c
final check
treelin611 Sep 24, 2024
c4c9ed6
Merge branch 'master' into rr_graphview_doxygen
treelin611 Sep 25, 2024
be2688f
rewrite rrgraphview brief
treelin611 Sep 25, 2024
d31435e
shorten
treelin611 Sep 25, 2024
b0380c2
reformat
treelin611 Sep 25, 2024
8f7c3a9
fix small bug: brief sections don't show up in the html documentation
treelin611 Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/src/api/vpr/rr_graph.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ RRGraphView

.. doxygenfile:: rr_graph_view.h
:project: librrgraph
:sections: detaileddescription
:sections: briefdescription detaileddescription func prototype user-defined public-func

.. doxygenclass:: RRGraphView
:project: librrgraph
Expand All @@ -18,7 +18,7 @@ RRGraphBuilder

.. doxygenfile:: rr_graph_builder.h
:project: librrgraph
:sections: detaileddescription
:sections: briefdescription detaileddescription func prototype user-defined public-func

.. doxygenclass:: RRGraphBuilder
:project: librrgraph
Expand All @@ -29,7 +29,7 @@ RRSpatialLookup

.. doxygenfile:: rr_spatial_lookup.h
:project: librrgraph
:sections: detaileddescription
:sections: briefdescription detaileddescription func prototype user-defined public-func

.. doxygenclass:: RRSpatialLookup
:project: librrgraph
Expand Down
20 changes: 14 additions & 6 deletions libs/librrgraph/src/base/rr_graph_builder.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class RRGraphBuilder {
t_rr_graph_storage& rr_nodes();
/** @brief Return a writable object for update the fast look-up of rr_node */
RRSpatialLookup& node_lookup();
/** .. warning:: The Metadata should stay as an independent data structure than rest of the internal data,
/** @warning The Metadata should stay as an independent data structure from the rest of the internal data,
* e.g., node_lookup! */
/** @brief Return a writable object for the meta data on the nodes */
MetadataStorage<int>& rr_node_metadata();
Expand Down Expand Up @@ -84,8 +84,12 @@ class RRGraphBuilder {

return segment_id;
}
/** TODO @brief Return a writable list of all the rr_segments
* .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_segments.
/**
* \internal
* TODO
* \endinternal
* @brief Return a writable list of all the rr_segments
* @warning It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_segments.
*/
inline vtr::vector<RRSegmentId, t_segment_inf>& rr_segments() {
return rr_segments_;
Expand All @@ -103,8 +107,12 @@ class RRGraphBuilder {

return switch_id;
}
/** TODO @brief Return a writable list of all the rr_switches
* .. warning:: It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_switches.
/**
* \internal
* TODO
* \endinternal
* @brief Return a writable list of all the rr_switches
* @warning It is not recommended to use this API unless you have to. The API may be deprecated later, and future APIs will designed to return a specific data from the rr_switches.
*/
inline vtr::vector<RRSwitchId, t_rr_switch_inf>& rr_switch() {
return rr_switch_inf_;
Expand Down Expand Up @@ -388,7 +396,7 @@ class RRGraphBuilder {
/* Detailed information about the switches, which are used in the RRGraph */
vtr::vector<RRSwitchId, t_rr_switch_inf> rr_switch_inf_;

/** .. warning:: The Metadata should stay as an independent data structure than rest of the internal data,
/** @warning The Metadata should stay as an independent data structure from the rest of the internal data,
* e.g., node_lookup! */
/* Metadata is an extra data on rr-nodes and edges, respectively, that is not used by vpr
* but simply passed through the flow so that it can be used by downstream tools.
Expand Down
Loading
Loading