Skip to content

Commit 1fb9f3f

Browse files
committed
docs: Add minimal doxygen setup
Add a Doxyfile and the minimum required tags to the sources to make anything useful appear in the documentation. To generate just run: doxygen from the project root or doxygen ./Doxyfile. Change-Id: Ie60eb1458586dc0a7843dca69e969b78817260d3 Signed-off-by: Brad Bishop <[email protected]>
1 parent 82c84bb commit 1fb9f3f

File tree

11 files changed

+2592
-0
lines changed

11 files changed

+2592
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ entityManagerTests
2525
.idea/
2626
cmake-build-debug/
2727
Testing
28+
html

Doxyfile

Lines changed: 2582 additions & 0 deletions
Large diffs are not rendered by default.

include/EntityManager.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file EntityManager.hpp
1617

1718
#pragma once
1819

include/Overlay.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file Overlay.hpp
1617

1718
#pragma once
1819
#include <nlohmann/json.hpp>

include/Utils.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file Utils.hpp
1617

1718
#pragma once
1819

include/VariantVisitors.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file VariantVisitors.hpp
1617

1718
#pragma once
1819
#include <stdexcept>

include/devices.hpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file devices.hpp
1617

1718
#pragma once
1819
#include <boost/container/flat_map.hpp>

src/EntityManager.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file EntityManager.cpp
1617

1718
#include "EntityManager.hpp"
1819

src/FruDevice.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file FruDevice.cpp
1617

1718
#include "Utils.hpp"
1819

src/Overlay.cpp

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
// See the License for the specific language governing permissions and
1414
// limitations under the License.
1515
*/
16+
/// \file Overlay.cpp
1617

1718
#include "Overlay.hpp"
1819

0 commit comments

Comments
 (0)