Updating doxygen commenting for a few NoC related files so that they are displayed better within the VPR documentation

Srivat97 · Srivat97 · commit a9ea0756b528 · 2023-07-07T09:57:05.000-04:00
diff --git a/vpr/src/noc/noc_data_types.h b/vpr/src/noc/noc_data_types.h
@@ -7,12 +7,15 @@
 struct noc_router_id_tag;
 struct noc_link_id_tag;
 
+/** Datatype to index routers within the NoC */
 typedef vtr::StrongId<noc_router_id_tag, int> NocRouterId;
+/** Datatype to index links within the NoC */
 typedef vtr::StrongId<noc_link_id_tag, int> NocLinkId;
 
 // data type to index traffic flows within the noc
 struct noc_traffic_flow_id_tag;
 
+/** Datatype to index traffic flows within the application */
 typedef vtr::StrongId<noc_traffic_flow_id_tag, int> NocTrafficFlowId;
 
 #endif
diff --git a/vpr/src/noc/noc_link.h b/vpr/src/noc/noc_link.h
@@ -1,7 +1,7 @@
 #ifndef NOC_LINK_H
 #define NOC_LINK_H
 
-/*
+/**
  * @file
  * @brief This file defines the NocLink class.
  *
diff --git a/vpr/src/noc/noc_router.h b/vpr/src/noc/noc_router.h
@@ -1,7 +1,7 @@
 #ifndef NOC_ROUTER_H
 #define NOC_ROUTER_H
 
-/*
+/**
  * @file
  * @brief This file defines the NocRouter class.
  *

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#ifndef NOC_LINK_H`
`2`	`2`	`#define NOC_LINK_H`
`3`	`3`
`4`		`-/*`
	`4`	`+/**`
`5`	`5`	`* @file`
`6`	`6`	`* @brief This file defines the NocLink class.`
`7`	`7`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`#ifndef NOC_ROUTER_H`
`2`	`2`	`#define NOC_ROUTER_H`
`3`	`3`
`4`		`-/*`
	`4`	`+/**`
`5`	`5`	`* @file`
`6`	`6`	`* @brief This file defines the NocRouter class.`
`7`	`7`	`*`