Commit Graph

11 Commits

Author SHA1 Message Date
MotoLegacy
4cfccb0785 Document and explicitly declare right analog stick input; display right analog stick in controller sample 2025-05-10 11:55:02 -07:00
Stéphane Blondon
277153114c add Code of Conduct in generated documentation
The Code of Conduct (CoC) was not included in the documentation generated by Doxyfile.
With this patch, the CoC is included, the link in the index exists and this warning is fixed:

[...]README.md:160: warning: unable to resolve reference to '/home/stephane/src/pspsdk/CODE_OF_CONDUCT.md' for \ref command
2025-04-29 01:19:25 +02:00
Stéphane Blondon
e9905349fb move generated documentation in dedicated directory
The documentation generated by Doxygen moves from doc/ to doc/build/.
There is a problem with using doc/ directory because when Doxygen produces the documentation, the doc/ directory is replaced so its content (style.css file) disappears.
2025-04-10 09:27:52 +02:00
Stéphane Blondon
fc8768fcf8 doc: fix obsolete tags warnings
When Doxygen generates the documentation (via `make doxygen-run`), it displays warnings such as:
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 102 of file 'Doxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

The patch contains only the modifications done by `doxygen -u`.
2025-04-07 21:49:23 +02:00
Stéphane Blondon
c302bae2bc doc: search improvement and link to constants
This patch fixes the search for function like __mcount() or gprof_start().
The issue existed for functions with function attribute (__attribute__()): Doxygen didn't parsed it properly. It fixes such warnings:
warning: documented symbol '__mcount' was not declared or defined.

After changing Doxygen configuration to fix it, new warnings appears. For example:
warning: explicit link request to 'PSP_VAUDIO_FORMAT_' could not be resolved

It's fixed by using the full name of the constants. By the way, it also fixes the link to the constants in the documentation.

Initial patch based on:
https://stackoverflow.com/questions/75410662/doxygen-does-not-parse-attribute-correctly
2025-04-03 21:57:55 +02:00
OrigamiK
67313bf745 enable docs search 2023-03-04 18:21:36 +05:30
OrigamiK
2c1ceee4f7 add reame as docs input 2023-03-04 18:15:41 +05:30
OrigamiK
0075f80c0f update doxyfile 2023-03-04 18:07:40 +05:30
OrigamiK
06fc12b816 add updated doc stylesheet 2023-03-04 18:01:24 +05:30
Carsten Teibes
95dbcb0461 Update Doxygen configuration 2020-05-16 03:49:59 +02:00
Johannes Ekberg
1bbde93d8a Updated (now actually working) Doxyfile 2014-02-07 22:15:05 +01:00