Skip to content

Commit

Permalink
docs: Add minimal doxygen setup
Browse files Browse the repository at this point in the history
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 <bradleyb@fuzziesquirrel.com>
  • Loading branch information
bradbishop committed Aug 28, 2020
1 parent 82c84bb commit 1fb9f3f
Show file tree
Hide file tree
Showing 11 changed files with 2,592 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,4 @@ entityManagerTests
.idea/
cmake-build-debug/
Testing
html
2,582 changes: 2,582 additions & 0 deletions Doxyfile

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions include/EntityManager.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file EntityManager.hpp

#pragma once

Expand Down
1 change: 1 addition & 0 deletions include/Overlay.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file Overlay.hpp

#pragma once
#include <nlohmann/json.hpp>
Expand Down
1 change: 1 addition & 0 deletions include/Utils.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file Utils.hpp

#pragma once

Expand Down
1 change: 1 addition & 0 deletions include/VariantVisitors.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file VariantVisitors.hpp

#pragma once
#include <stdexcept>
Expand Down
1 change: 1 addition & 0 deletions include/devices.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file devices.hpp

#pragma once
#include <boost/container/flat_map.hpp>
Expand Down
1 change: 1 addition & 0 deletions src/EntityManager.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file EntityManager.cpp

#include "EntityManager.hpp"

Expand Down
1 change: 1 addition & 0 deletions src/FruDevice.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file FruDevice.cpp

#include "Utils.hpp"

Expand Down
1 change: 1 addition & 0 deletions src/Overlay.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file Overlay.cpp

#include "Overlay.hpp"

Expand Down
1 change: 1 addition & 0 deletions src/Utils.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
*/
/// \file Utils.cpp

#include "Utils.hpp"

Expand Down

0 comments on commit 1fb9f3f

Please sign in to comment.