Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Doxygen-styled comments to parts of the libretro API #15641

Merged
merged 132 commits into from
Mar 10, 2024
Merged

Add Doxygen-styled comments to parts of the libretro API #15641

Changes from 25 commits
Commits
Show all changes
132 commits
Select commit Hold shift + click to select a range
9a6f5d9
Touch up the documentation for a few environment calls
JesseTG Aug 23, 2023
80d4e53
Touch up more comments
JesseTG Aug 25, 2023
f604628
Update docs for more environment calls
JesseTG Aug 28, 2023
c5ef438
Add doc comments for more environment calls
JesseTG Aug 28, 2023
bf516e5
Change various @returns to indicate that the environment call is avai…
JesseTG Aug 28, 2023
c3f1322
Note some deprecated symbols
JesseTG Aug 29, 2023
324ed96
Touch up the docs for RETRO_ENVIRONMENT_SET_MESSAGE
JesseTG Aug 29, 2023
165e454
Touch up the docs for RETRO_ENVIRONMENT_SET_PIXEL_FORMAT
JesseTG Aug 29, 2023
a1a06e3
Add more doc comments
JesseTG Aug 30, 2023
127179c
(libretro) Add more doxygen documentation for the libretro API
RobLoach Aug 31, 2023
6a89b5a
(libretro) Add doxygen comments for the callbacks
RobLoach Sep 3, 2023
f7845e0
Document retro_init and retro_deinit
JesseTG Sep 4, 2023
a8dbb63
Add comments for retro_log-related symbols
JesseTG Sep 4, 2023
d68b6ca
Add a comment
JesseTG Sep 4, 2023
15d91f4
Clean up some camera-related comments
JesseTG Sep 4, 2023
349039c
Clean up frame time-related callbacks
JesseTG Sep 4, 2023
41bdf2e
Merge remote-tracking branch 'origin/jtg/docs-improvements' into jtg/…
JesseTG Sep 4, 2023
972ca8b
Correct some information about major callbacks
JesseTG Sep 4, 2023
d44be24
Clarify some parameter info
JesseTG Sep 4, 2023
899b78d
Fix incorrect info about retro_set_environment
JesseTG Sep 4, 2023
1c11d36
Update libretro-common/include/libretro.h
JesseTG Sep 5, 2023
9669889
(libretro) Add doxygen docs on RETRO_THROTTLE
RobLoach Sep 5, 2023
55f1bad
Touch up the docs for RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK
JesseTG Sep 6, 2023
e8a82aa
Touch up the docs for some macros
JesseTG Sep 6, 2023
0ec8f43
Touch up the docs for some more environment calls
JesseTG Sep 6, 2023
c195ff1
Update libretro-common/include/libretro.h
JesseTG Sep 7, 2023
f6fc0bc
Update libretro-common/include/libretro.h
JesseTG Sep 7, 2023
e88baf8
Update libretro-common/include/libretro.h
JesseTG Sep 7, 2023
e57b6df
Update libretro-common/include/libretro.h
JesseTG Sep 7, 2023
fee528a
Tidy up the doc comments for clamping.h
JesseTG Sep 7, 2023
ac4728f
Define some sections for constants
JesseTG Sep 7, 2023
67aa098
Fix a duplicate @see
JesseTG Sep 7, 2023
65f4eb8
Polish up the docs for the rumble interface
JesseTG Sep 7, 2023
1de7a1d
Polish up the docs for RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES
JesseTG Sep 7, 2023
a40bad7
Update libretro-common/include/libretro.h
JesseTG Sep 9, 2023
92f91e0
Document INLINE
JesseTG Sep 9, 2023
66e937f
Clean up some tags
JesseTG Sep 9, 2023
1728445
Touch up the docs for the sensor interface
JesseTG Sep 9, 2023
a42640e
Add docs for RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK
JesseTG Sep 9, 2023
6221252
Update docs for RETRO_ENVIRONMENT_GET_INPUT_BITMASKS and accompanying…
JesseTG Sep 9, 2023
5951d40
Update some group definitions
JesseTG Sep 9, 2023
8b2d8de
Spiff up the docs for retro_dirent.h
JesseTG Sep 12, 2023
5b0ab44
Document dylib.h
JesseTG Sep 12, 2023
5b1019f
Document base64.h
JesseTG Sep 12, 2023
a7a9b7d
Document crc32.h
JesseTG Sep 12, 2023
e88c60e
Touch up the docs for audio conversion functions
JesseTG Sep 12, 2023
2ccacfb
Clean up some Doxygen tags
JesseTG Sep 12, 2023
fdc084d
Refine the docs for RETRO_ENVIRONMENT_GET_PERF_INTERFACE
JesseTG Sep 13, 2023
324cb66
Fix incorrect infor in dylib.h
JesseTG Sep 13, 2023
b5f8540
Touch up the docs for RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE
JesseTG Sep 14, 2023
b5fa9e5
Revise the docs for RETRO_ENVIRONMENT_SET_GEOMETRY
JesseTG Sep 14, 2023
b0e6008
Revise the docs for RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE
JesseTG Sep 15, 2023
9d27589
Revise a function's doc
JesseTG Sep 15, 2023
8481efb
Touch up most of the rthreads docs
JesseTG Sep 18, 2023
96c8527
Touch up the retro_timers.h docs
JesseTG Sep 18, 2023
4ccf335
Revise the subsystem docs
JesseTG Sep 19, 2023
e419485
Fix some incorrect @see's
JesseTG Sep 19, 2023
71e2658
Touch up the docs for RETRO_ENVIRONMENT_GET_LED_INTERFACE
JesseTG Sep 22, 2023
1c6bb96
Give the RETRO_ENVIRONMENT_GET_SAVESTATE_CONTEXT docs a makeover
JesseTG Sep 22, 2023
1023aba
Slight cleanup to the microphone docs
JesseTG Sep 22, 2023
041f1af
Slight cleanup to the device power docs
JesseTG Sep 22, 2023
f73ef1e
Touch up serialization quirk docs
JesseTG Sep 22, 2023
b4f80fa
Give the MIDI docs a haircut
JesseTG Sep 22, 2023
efcf911
Update libretro-common/include/libretro.h
JesseTG Sep 23, 2023
027d5b6
Freshen up rtime's docs
JesseTG Sep 23, 2023
2c1bfe6
Improve the docs and accompanying definitions for RETRO_ENVIRONMENT_G…
JesseTG Sep 23, 2023
e8e298d
Shine the shoes of RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS's docs
JesseTG Sep 23, 2023
122a37c
Freshen up the docs for fifo_queue.h
JesseTG Sep 23, 2023
796416c
Document most of task_queue.h
JesseTG Sep 25, 2023
24b9753
Put retro_dirent's symbols in a group
JesseTG Sep 26, 2023
02c3169
Finish documenting task_queue.h
JesseTG Sep 26, 2023
4c744f7
Document some compatibility headers
JesseTG Sep 26, 2023
41d21d3
Document read_stdin
JesseTG Sep 27, 2023
5bfcb55
Document file_stream_transforms.h
JesseTG Sep 27, 2023
5e6508d
Document the VFS API
JesseTG Oct 2, 2023
fb42832
(Docs) Add doxygen notes about RETRO_DEVICE_*
RobLoach Oct 3, 2023
a455188
Fix some line breaks
JesseTG Oct 3, 2023
4e14add
Revise RETRO_DEVICE docs
JesseTG Oct 3, 2023
deec422
Document strl.h
JesseTG Oct 10, 2023
87ea39a
Update the features_cpu.h docs
JesseTG Oct 10, 2023
931f589
Rewrite the docs for file_stream.h
JesseTG Oct 16, 2023
f697306
Update the docs for retro_endianness.h
JesseTG Oct 17, 2023
c7e98d8
Update the docs for retro_miscellaneous.h
JesseTG Oct 17, 2023
da11c66
Document the RETRO_VFS_SEEK_POSITION constants
JesseTG Oct 17, 2023
892c368
Finish documenting rthreads.h
JesseTG Oct 18, 2023
443c1aa
Document network_stream.h
JesseTG Oct 18, 2023
073fe8c
Put the RETRO_MEMORY defines in a defgroup
JesseTG Oct 20, 2023
fdd5085
Move a doc comment in retro_common.h to file scope
JesseTG Oct 20, 2023
f7cab18
Revise the docs for RETRO_ENVIRONMENT_SET_CONTROLLER_INFO, and accomp…
JesseTG Oct 22, 2023
df99457
Fix the @param/in/out order in libretro.h's @param declarations
JesseTG Oct 22, 2023
8a49b92
Tidy up the docs for RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION
JesseTG Oct 23, 2023
c921852
Spiff up the docs for RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER
JesseTG Oct 23, 2023
48d2c5b
Fix some tags
JesseTG Oct 23, 2023
389a5d2
Polish up RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE's docs
JesseTG Oct 24, 2023
802b2a8
libretro: Add header doxygen
RobLoach Nov 2, 2023
2aea63a
Update libretro-common/include/libretro.h
JesseTG Nov 2, 2023
065af45
Update libretro-common/include/libretro.h
JesseTG Nov 2, 2023
e9271f9
Merge pull request #1 from RobLoach/readme-header
JesseTG Nov 2, 2023
f651349
Clean up the docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY
JesseTG Oct 24, 2023
d0e2683
Clean up the docs for RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIA…
JesseTG Oct 24, 2023
7729c46
Touch up some comment syntax for RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE
JesseTG Oct 30, 2023
a5f0b5b
Fix some inaccuracies
JesseTG Oct 30, 2023
2d85766
Re-add the license statement for libretro.h
JesseTG Nov 3, 2023
4b3011e
Touch up the docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2
JesseTG Nov 6, 2023
2a81579
Touch up docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY
JesseTG Nov 6, 2023
bcb12bb
Touch up docs for some options-related symbols
JesseTG Nov 6, 2023
517ece6
Fix some syntax that was preventing most doc files from being generated
JesseTG Nov 6, 2023
8103c50
Express retro_core_option_definition docs in terms of retro_core_opti…
JesseTG Nov 15, 2023
a7ff413
Finalize some core option-related docs
JesseTG Nov 15, 2023
4f485dc
Fix some incorrect info about achievements
JesseTG Nov 16, 2023
1273fda
Polish up the docs for RETRO_ENVIRONMENT_SET_MEMORY_MAPS
JesseTG Nov 16, 2023
00c7ea6
Polish up the docs for RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_V…
JesseTG Nov 16, 2023
e010211
Add a notice for `RETRO_ENVIRONMENT_GET_LOG_INTERFACE`
JesseTG Nov 28, 2023
04719ef
Update the disk control interface docs
JesseTG Nov 28, 2023
726540c
Add a sentence to a doc comment
JesseTG Dec 4, 2023
51b235d
Update a comment
JesseTG Dec 4, 2023
e6fca0e
Remove an irrelevant @todo
JesseTG Dec 4, 2023
eb130df
Touch up the docs for `retro_message_target`
JesseTG Dec 4, 2023
0716a57
Touch up the docs for `retro_message_type`
JesseTG Dec 4, 2023
8c2f9b5
Touch up the docs for `RETRO_ENVIRONMENT_SET_MESSAGE_EXT`
JesseTG Dec 4, 2023
1cae9b3
Touch up the docs for `RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALL…
JesseTG Dec 4, 2023
611dee1
Touch up the docs for `RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY`
JesseTG Dec 4, 2023
699e5f2
Merge branch 'master' into jtg/docs-improvements
JesseTG Dec 19, 2023
e492fbd
Revise a comment
JesseTG Dec 27, 2023
5433da6
Revise the docs for `RETRO_ENVIRONMENT_SET_VARIABLE`
JesseTG Dec 27, 2023
cbc554e
Add a `@see`
JesseTG Dec 27, 2023
0fa502e
Clean up the `RETRO_ENVIRONMENT_SET_FASTFORWARDING_OVERRIDE` docs
JesseTG Dec 27, 2023
c8b88cc
Update the Doxyfile
JesseTG Jan 3, 2024
c97efb5
Merge branch 'master' into jtg/docs-improvements
JesseTG Jan 24, 2024
551110f
libretro: Add three more environment callback doxygen docs
RobLoach Jan 29, 2024
7cfc955
Merge pull request #2 from RobLoach/doxygen-env
JesseTG Jan 29, 2024
dbce707
doxygen: Remove @example reference
RobLoach Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading