Skip to content

Commit 4539a8f

Browse files
authored
Merge pull request #2887 from verilog-to-routing/fix_devgrid_doxygen
Fix DeviceGrid doxygen
2 parents 1279554 + fa55ebb commit 4539a8f

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

doc/_doxygen/vpr.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ EXTRACT_ALL = YES
66
EXTRACT_PRIVATE = YES
77
EXTRACT_STATIC = YES
88
WARN_IF_UNDOCUMENTED = NO
9-
INPUT = ../../vpr
9+
INPUT = ../../vpr ../../libs/libarchfpga/
1010
RECURSIVE = YES
1111
GENERATE_HTML = NO
1212
GENERATE_LATEX = NO

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+
//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.
24+
/**
25+
* @class DeviceGrid
26+
* @brief Represents the FPGA fabric. It is used to get information about different layers and tiles.
27+
*/
2428
class DeviceGrid {
2529
public:
2630
DeviceGrid() = default;

0 commit comments

Comments
 (0)