Skip to content

Commit a5b1199

Browse files
add @Class to DeviceGrid doxygen comment
1 parent 1279554 commit a5b1199

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

libs/libarchfpga/src/device_grid.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,12 @@ struct t_grid_tile {
1919
const t_metadata_dict* meta = nullptr;
2020
};
2121

22-
///@brief DeviceGrid represents the FPGA fabric. It is used to get information about different layers and tiles.
23-
// TODO: All of the function that use helper functions of this class should pass the layer_num to the functions, and the default value of layer_num should be deleted eventually.
22+
/**
23+
* @class DeviceGrid
24+
* @brief Represents the FPGA fabric. It is used to get information about different layers and tiles.
25+
*
26+
* TODO: All of the functions that use helper functions of this class should pass the layer_num to the functions, and the default value of layer_num should be deleted eventually.
27+
*/
2428
class DeviceGrid {
2529
public:
2630
DeviceGrid() = default;

0 commit comments

Comments
 (0)