FrznChess/chessmcu
FrznChess/chessmcu
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: bringing in doxygen-awesome-css, added more inline documentation

Browse source 
The doxygen-awesome-css project is just a nice, simple, customizable
CSS system for making doxygen look less like 1992 and more like
2022. I need to spend a bunch of time tweaking it to make it
look good, and perhaps match it to the style already used at
chess.frzn.dev.

Added more inline Doxycomments, and also generated an image that
represents the logical layout of the boardGrid member variable,
showing the mirrored layout. This works well for our project
because of the way the serial data comes in.
This commit is contained in:
A.M. Rowsell 2025-09-16 03:21:53 -04:00
commit fa9d534e94
Signed by untrusted user who does not match committer: amr
GPG key ID: E0879EDBDB0CA7B1
6 changed files with 38 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

2
inc/Piece.hpp
View file

@ -75,7 +75,7 @@ struct Move {
};
/**
* @class Piece Piece.hpp "inc/Piece.hpp"
* @class Piece Piece.hpp inc/Piece.hpp
* @brief A class abstracting chess pieces
*
* This is a polymorphic base class containing the basic properties all chess pieces have.