mirror of
https://gitlab.com/manzerbredes/ochess.git
synced 2025-04-19 04:09:41 +00:00
Improve doxygen documentation
This commit is contained in:
parent
a6bfdf40d5
commit
055410c0e0
6 changed files with 85 additions and 9 deletions
|
@ -1,4 +1,21 @@
|
|||
Board Theming
|
||||
======
|
||||
|
||||
TBA
|
||||
In OChess, every board skins (squares and pieces) are made of *200x200* pixels tiles stored in <i>.png</i> images. OChess is in charge of breaking these tiles apart into individual elements.
|
||||
|
||||
### Squares
|
||||
Squares skins are <i>.png</i> images, with a dimension of *400x200* pixels (2 tiles next to each other). The tile starting at pixel (0,0) are for dark squares and the other one for light squares.
|
||||
|
||||
### Pieces
|
||||
|
||||
Pieces skins are <i>.png</i> images, with a dimension of *400x1200* pixels (2 columns of 6 tiles). The first column, starting at pixel (0,0) are for black pieces and the other column for the white pieces. From top, to bottom pieces are in the following order: King, Queen, Rook, Bishop, Knight, Pawn.
|
||||
|
||||
### Create a Skin with generate.sh
|
||||
|
||||
To create a pieces skin named *myskin*, create the folder `tools/skin/pieces/myskin`. In this folder, place all the pieces in the <i>.svg</i> format with the following name convention: `bb.svg` for <b>b</b>lack <b>b</b>ishop, `wk.svg` for <b>w</b>hite <b>k</b>ing, `wn.svg` for <b>w</b>hite <b>k</b>night, `bn.svg` for <b>b</b>lack <b>k</b>night,...
|
||||
|
||||
Then, run the `tools/skin/generate.sh` script. This script will combine the <i>.svg</i> file into a single <i>.png</i> file located in `tools/assets/pieces/myskin.png`.
|
||||
|
||||
Use the same approach to create boards skins.
|
||||
|
||||
**Note:** The `tools/skin/generate.sh` script is meant to be used on Linux Distributions and requires [Bash](https://www.gnu.org/software/bash/), [ImageMagick](https://imagemagick.org/) and [Inkscape](https://inkscape.org/).
|
|
@ -505,7 +505,7 @@ EXTRACT_ALL = NO
|
|||
# be included in the documentation.
|
||||
# The default value is: NO.
|
||||
|
||||
EXTRACT_PRIVATE = NO
|
||||
EXTRACT_PRIVATE = YES
|
||||
|
||||
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
|
||||
# methods of a class will be included in the documentation.
|
||||
|
@ -917,7 +917,7 @@ WARN_LOGFILE =
|
|||
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
|
||||
# Note: If this tag is empty the current directory is searched.
|
||||
|
||||
INPUT = ../../src MainPage.md Opening.md BoardTheming.md
|
||||
INPUT = ../../src MainPage.md Opening.md BoardTheming.md Libraries.md
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
|
||||
|
|
24
tools/doxygen/Libraries.md
Normal file
24
tools/doxygen/Libraries.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
Internal Libraries
|
||||
====
|
||||
|
||||
Ochess uses 5 internal libraries (excluding [wxWidgets](https://www.wxwidgets.org/)):
|
||||
- [cgeditor](https://gitlab.com/manzerbredes/cgeditor): A 2D chess game moves presenter/editor
|
||||
- [pgnp](https://gitlab.com/manzerbredes/pgnp): An efficient PGN parser
|
||||
- [chessarbiter](https://gitlab.com/manzerbredes/chessarbiter): A chess classical chess game arbiter for C++
|
||||
- [uciadapter](https://gitlab.com/manzerbredes/uciadapter): A cross platform utility to interact with UCI chess engines
|
||||
- [chess-move-interface](https://gitlab.com/manzerbredes/chess-move-interface): A chess half move interface for libraries interoperability
|
||||
|
||||
### CGEditor
|
||||
It is only used in EditorCanvas.
|
||||
|
||||
### PGNP
|
||||
It is only used in PGNGameBase.
|
||||
|
||||
### ChessArbiter
|
||||
Mostly used in Game and HalfMove.
|
||||
|
||||
### UCIAdapter
|
||||
Used in various engine related areas such as MainWindow, EngineTab and LiveEngineDialog.
|
||||
|
||||
### Chess-Move-Interface
|
||||
Used in various region of OChess such as PGNGameBase and HalfMove.
|
|
@ -1,7 +1,7 @@
|
|||
%Opening Names DB
|
||||
=====
|
||||
|
||||
The chess opening names database uses the [Lichess chess-openings](https://github.com/lichess-org/chess-openings) project. The script `tools/openings.sh` is used to fetch the last updates from the project, and generate the `binres/openings.hpp` file.
|
||||
The chess opening names database uses the [Lichess chess-openings](https://github.com/lichess-org/chess-openings) project. The script `tools/openings.sh` is used to fetch the last updates from the project, and generate the `binres/openings.hpp` file. In turn, this file is used in Openings.hpp.
|
||||
|
||||
|
||||
#### Acknowledgements
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue