Skip to content

Commit 14ea3ca

Browse files
authored
Clarify version info and generation tools in documentation
Updated the project version information and clarified the generation tools used for various files.
1 parent af3567c commit 14ea3ca

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

.github/copilot-instructions.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Doxygen is the de facto standard tool for generating documentation from annotated source code. It supports C++, C, Objective-C, C#, PHP, Java, Python, IDL, Fortran, VHDL, and more. The project is written primarily in C++ (C++17) and uses Flex (`.l` files) for lexical scanning, Python scripts for code generation, and CMake as its build system.
66

7-
Current version: **1.17.0**
7+
Current version can be found in the VERSION file in the root of the repository. This is typically the development version (to be released version).
88

99
## Repository Structure
1010

@@ -170,7 +170,10 @@ Use `-t [tracefile]` for full tracing output (very verbose; useful for experts).
170170
- `<build>/generated_src/configvalues.cpp` – from `config.xml` via `configgen.py`
171171
- `<build>/generated_src/configoptions.cpp` – from `config.xml` via `configgen.py`
172172
- `<build>/generated_src/settings.h` – from CMake configuration
173-
- Scanner `.cpp` files – generated from `.l` files by Flex
173+
- Scanner `.cpp` files – generated from `.l` files by GNU flex
174+
- `<build>/generate_src/ce_parse.cpp` - from `constexp.y` generated by GNU bison
175+
- files in `vhdlparser` directory that have `Generated By:JavaCC:` in the header are generated by JavaCC.
176+
- Python files in `addon/doxmlparser/doxmlparser` are generated by generateDS (https://www.davekuhlman.org/generateDS.html)
174177

175178
## CI/CD
176179

@@ -183,7 +186,7 @@ Tests run on: Ubuntu (GCC & Clang, Intel & ARM), macOS (Intel & Apple Silicon),
183186
### Bundled (in `deps/`)
184187
- `spdlog` – logging
185188
- `fmt` – string formatting
186-
- `sqlite3`search index database
189+
- `sqlite3`for SQLite output format
187190
- `TinyDeflate` – compression
188191
- `liblodepng` – PNG generation
189192
- `libmscgen` – MSC diagram rendering
@@ -210,3 +213,4 @@ Tests run on: Ubuntu (GCC & Clang, Intel & ARM), macOS (Intel & Apple Silicon),
210213
- User manual: https://www.doxygen.nl/manual/
211214
- Internal docs (generated): https://doxygen.github.io/doxygen-docs/
212215
- Issue tracker: https://github.com/doxygen/doxygen/issues
216+
- Repository with workflow to generate official binaries: https://github.com/doxygen/doxygen-release/

0 commit comments

Comments
 (0)