search

wpilibsuite / allwpilib

Official Repository of WPILibJ and WPILibC
https://wpilib.org/
Other
1.07k stars 614 forks source link

frc::filesystem doxygen has incorrect page name #3560

Closed dawonn closed 2 years ago

dawonn commented 3 years ago

https://first.wpi.edu/FRC/roborio/release/docs/cpp/namespacefrc_1_1filesystem.html image

the frc::filesystem class is shown under the 'detail' menu in the namespace tree navigation bar on the left ^

I would expect it to exist under it's own menu entry just like the other frc::classes

AustinShalit commented 3 years ago

Note that Doxygen is producing the correct output. Filesystem is only a namespace and not a class - https://github.com/wpilibsuite/allwpilib/blob/main/wpilibc/src/main/native/include/frc/Filesystem.h

sciencewhiz commented 3 years ago

In the 2022 development docs it has its own entry.

E03EC3C5-5827-4239-B280-8E91C7F3BDE2

FYI, you linked the 2020 docs, 2021 docs are here: https://first.wpi.edu/wpilib/allwpilib/docs/release/cpp/index.html

dawonn commented 3 years ago

double thanks. it was a bit difficult to discover but I see it now.

PeterJohnson commented 3 years ago

The fact this is done with a namespace instead of a class with static functions is fairly common in broader C++ but is unusual for WPILibC. For consistency with other classes (e.g. SmartDashboard) and Java, should this be changed to be a normal class with static functions?

sciencewhiz commented 2 years ago

Closing since 2022 released and it has it's own entry