60 Commits

Author SHA1 Message Date
Jesse Talavera
b7ddac2431
Add Doxygen-styled comments to parts of the libretro API (#15641)
* Touch up the documentation for a few environment calls

* Touch up more comments

* Update docs for more environment calls

* Add doc comments for more environment calls

* Change various @returns to indicate that the environment call is available

- Some environment calls might be recognized but ignored (e.g. when fast-forwarding during netplay)

* Note some deprecated symbols

* Touch up the docs for RETRO_ENVIRONMENT_SET_MESSAGE

* Touch up the docs for RETRO_ENVIRONMENT_SET_PIXEL_FORMAT

* Add more doc comments

* (libretro) Add more doxygen documentation for the libretro API

* (libretro) Add doxygen comments for the callbacks

* Document retro_init and retro_deinit

* Add comments for retro_log-related symbols

* Add a comment

* Clean up some camera-related comments

* Clean up frame time-related callbacks

* Correct some information about major callbacks

* Clarify some parameter info

* Fix incorrect info about retro_set_environment

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* (libretro) Add doxygen docs on RETRO_THROTTLE

* Touch up the docs for RETRO_ENVIRONMENT_SET_AUDIO_CALLBACK

* Touch up the docs for some macros

* Touch up the docs for some more environment calls

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Tidy up the doc comments for clamping.h

- It was a low-hanging fruit

* Define some sections for constants

- Doxygen will group all contained symbols on one page

* Fix a duplicate @see

* Polish up the docs for the rumble interface

* Polish up the docs for RETRO_ENVIRONMENT_GET_INPUT_DEVICE_CAPABILITIES

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Document INLINE

* Clean up some tags

* Touch up the docs for the sensor interface

* Add docs for RETRO_ENVIRONMENT_SET_PROC_ADDRESS_CALLBACK

* Update docs for RETRO_ENVIRONMENT_GET_INPUT_BITMASKS and accompanying names

* Update some group definitions

* Spiff up the docs for retro_dirent.h

* Document dylib.h

* Document base64.h

* Document crc32.h

* Touch up the docs for audio conversion functions

* Clean up some Doxygen tags

* Refine the docs for RETRO_ENVIRONMENT_GET_PERF_INTERFACE

* Fix incorrect infor in dylib.h

* Touch up the docs for RETRO_ENVIRONMENT_GET_CAMERA_INTERFACE

* Revise the docs for RETRO_ENVIRONMENT_SET_GEOMETRY

* Revise the docs for RETRO_ENVIRONMENT_GET_LOCATION_INTERFACE

* Revise a function's doc

* Touch up most of the rthreads docs

* Touch up the retro_timers.h docs

* Revise the subsystem docs

* Fix some incorrect @see's

* Touch up the docs for RETRO_ENVIRONMENT_GET_LED_INTERFACE

* Give the RETRO_ENVIRONMENT_GET_SAVESTATE_CONTEXT docs a makeover

* Slight cleanup to the microphone docs

* Slight cleanup to the device power docs

* Touch up serialization quirk docs

* Give the MIDI docs a haircut

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Freshen up rtime's docs

* Improve the docs and accompanying definitions for RETRO_ENVIRONMENT_GET_AUDIO_VIDEO_ENABLE

- Revise the text of the documentation
- Introduce an enum that defines the flags (it's still an int, so ABI compatibility will be fine)
- Move the documentation for each bit to its corresponding enum

* Shine the shoes of RETRO_ENVIRONMENT_GET_INPUT_MAX_USERS's docs

* Freshen up the docs for fifo_queue.h

* Document most of task_queue.h

* Put retro_dirent's symbols in a group

* Finish documenting task_queue.h

* Document some compatibility headers

* Document read_stdin

* Document file_stream_transforms.h

* Document the VFS API

- Not the wrappers, just the plain API itself

* (Docs) Add doxygen notes about RETRO_DEVICE_*

* Fix some line breaks

* Revise RETRO_DEVICE docs

* Document strl.h

* Update the features_cpu.h docs

* Rewrite the docs for file_stream.h

* Update the docs for retro_endianness.h

* Update the docs for retro_miscellaneous.h

* Document the RETRO_VFS_SEEK_POSITION constants

* Finish documenting rthreads.h

* Document network_stream.h

* Put the RETRO_MEMORY defines in a defgroup

* Move a doc comment in retro_common.h to file scope

* Revise the docs for RETRO_ENVIRONMENT_SET_CONTROLLER_INFO, and accompanying symbols

* Fix the @param/in/out order in libretro.h's @param declarations

* Tidy up the docs for RETRO_ENVIRONMENT_GET_CORE_OPTIONS_VERSION

* Spiff up the docs for RETRO_ENVIRONMENT_GET_CURRENT_SOFTWARE_FRAMEBUFFER

* Fix some tags

* Polish up RETRO_ENVIRONMENT_GET_HW_RENDER_INTERFACE's docs

* libretro: Add header doxygen

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Update libretro-common/include/libretro.h

Co-authored-by: Rob Loach <robloach@gmail.com>

* Clean up the docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY

* Clean up the docs for RETRO_ENVIRONMENT_SET_HW_RENDER_CONTEXT_NEGOTIATION_INTERFACE

* Touch up some comment syntax for RETRO_ENVIRONMENT_GET_VARIABLE_UPDATE

* Fix some inaccuracies

* Re-add the license statement for libretro.h

* Touch up the docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_V2

* Touch up docs for RETRO_ENVIRONMENT_SET_CORE_OPTIONS_DISPLAY

* Touch up docs for some options-related symbols

* Fix some syntax that was preventing most doc files from being generated

* Express retro_core_option_definition docs in terms of retro_core_option_v2_definition

* Finalize some core option-related docs

* Fix some incorrect info about achievements

* Polish up the docs for RETRO_ENVIRONMENT_SET_MEMORY_MAPS

* Polish up the docs for RETRO_ENVIRONMENT_GET_DISK_CONTROL_INTERFACE_VERSION

* Add a notice for `RETRO_ENVIRONMENT_GET_LOG_INTERFACE`

* Update the disk control interface docs

* Add a sentence to a doc comment

* Update a comment

* Remove an irrelevant @todo

* Touch up the docs for `retro_message_target`

* Touch up the docs for `retro_message_type`

* Touch up the docs for `RETRO_ENVIRONMENT_SET_MESSAGE_EXT`

* Touch up the docs for `RETRO_ENVIRONMENT_SET_AUDIO_BUFFER_STATUS_CALLBACK`

* Touch up the docs for `RETRO_ENVIRONMENT_SET_MINIMUM_AUDIO_LATENCY`

* Revise a comment

* Revise the docs for `RETRO_ENVIRONMENT_SET_VARIABLE`

* Add a `@see`

* Clean up the `RETRO_ENVIRONMENT_SET_FASTFORWARDING_OVERRIDE` docs

* Update the Doxyfile

* libretro: Add three more environment callback doxygen docs

* doxygen: Remove @example reference

---------

Co-authored-by: Rob Loach <robloach@gmail.com>
2024-03-09 17:24:01 -08:00
LibretroAdmin
ec6f4c1f55 (libretro-common) refinements to documentation 2022-08-01 13:06:35 +02:00
jdgleaver
f52fbd32a0 (libretro-common/file_stream) Restore missing filestream_scanf() function 2021-09-24 12:12:52 +02:00
jdgleaver
6c5e17e5ae
Fix file_stream_transforms:rfscanf() (#13023) 2021-09-21 17:04:34 +02:00
twinaphex
cd9ca691ca (libretro-common) Update copyright 2020-01-31 15:43:42 +01:00
Twinaphex
29dc30fa48
Revert " add hashing support for PSX cheevos (bin/cue, chd, or real CD)" 2019-08-30 15:55:07 +02:00
Jamiras
bcd61d7f9b add hashing support for PSX cheevos (bin/cue, chd, or real CD) 2019-08-29 21:05:14 -06:00
twinaphex
d6df17a154 Revert "add hashing support for PSX cheevos (bin/cue, chd, or real CD)"
This reverts commit 11854333742fd7887cfa4f818d848963a82fab76.
2019-08-30 03:14:42 +02:00
Jamiras
1185433374 add hashing support for PSX cheevos (bin/cue, chd, or real CD) 2019-08-23 08:02:06 -06:00
Brad Parker
7935cc80ee media: add function to parse cue and detect system from first data track 2019-07-30 02:37:00 -04:00
Brad Parker
41b3adc8a4 cdrom: always request one sector at a time 2019-07-21 12:06:10 -04:00
Brad Parker
9617605371 cdrom: set optimal read speed 2019-06-30 18:34:00 -04:00
twinaphex
653bcba2e0 Update libretro-common 2018-08-07 06:17:48 +02:00
twinaphex
c563eedb32 Hopefully the VFS interface can now remain stable 2018-08-07 05:53:32 +02:00
twinaphex
e8b0d6974d Merge commit '48cb38619ff8bbc5ff3c0df93704b3297047a8fe' 2018-06-22 15:00:02 +02:00
twinaphex
768ebbfdb5 Merge commit 'ce9ce1d35387ef8144e53bf071396fa075bfb6c5' as 'libretro-common' 2018-05-12 17:56:34 +02:00
twinaphex
0548349991 Remove libretro-common 2018-05-12 17:56:14 +02:00
twinaphex
be7eb4de1c Update libretro-common 2018-04-16 08:57:17 +02:00
twinaphex
1751f4a0af Make it possible to read bigger files by replacing ssize_t with int64_t
and size_t with uint64_t
2018-04-13 00:18:11 +02:00
twinaphex
85d3be1245 Update libretro-common 2018-03-23 11:17:56 +01:00
twinaphex
6622cb0810 Update libretro API 2017-12-16 14:12:38 +01:00
twinaphex
1b6b670882 filestream - use int64_t 2017-12-15 21:10:58 +01:00
twinaphex
1932513edb Update libretro-common 2017-12-15 00:31:37 +01:00
twinaphex
c7c4b723d6 Move path_file_exists to filestream and do away with filestream
dependencies in file/file_path
2017-12-14 20:05:46 +01:00
Brad Parker
8c0adf3594 move path_file_rename and path_file_remove into VFS 2017-12-14 13:32:26 -05:00
twinaphex
0b6c191354 Start moving file stream code over to vfs_implementation.c 2017-12-14 14:03:42 +01:00
twinaphex
7788a852c0 Some more cleanups 2017-12-14 00:16:18 +01:00
twinaphex
57b730ab61 Start implementing VFS layer ; first split up VFS libretro functionality
to separate header until things are finalized
2017-12-11 21:24:14 +01:00
twinaphex
ad70bb9866 Get rid of unused filestream_get_ext 2017-12-11 17:42:00 +01:00
twinaphex
43c9bb374d filestream_set_size can be made a static function 2017-12-11 17:39:56 +01:00
twinaphex
61d3f90cae Add hint defines to libretro.h 2017-12-11 12:53:47 +01:00
twinaphex
318f17c4cb Start using VFS API constant defines 2017-12-11 12:15:00 +01:00
twinaphex
93ee4df5f5 Move RFILE_HINT_UNBUFFERED to file_stream.c 2017-12-11 11:47:13 +01:00
twinaphex
e1461cc0de Get rid of hashes in config_file.c 2017-12-11 11:40:36 +01:00
twinaphex
2fd8210e59 Create shareable filestream_getline 2017-12-10 22:35:08 +01:00
twinaphex
2e979ec537 Replace function signatures of file_stream file functions 2017-12-10 22:25:38 +01:00
twinaphex
a8e031777e * Get rid of RFILE_MODE_READ_TEXT
* Get rid of PSP ifdef sinside file_stream.c
2017-12-10 22:05:24 +01:00
Alcaro
dca30d533f
Update file_stream.h 2017-12-04 14:31:11 +01:00
Alcaro
130e4522e2
Update file_stream.h 2017-12-04 13:51:25 +01:00
Alcaro
50148c03e2
not used anymore
4e66962ba8
2017-12-04 13:27:05 +01:00
Brad Parker
94aa2cd08a document setvbuf changes, only call it with bufsize >0 2017-11-17 16:12:36 -05:00
Brad Parker
68a8198e4a convert more file IO functions to use filestream, fixes encoding issues on Windows 2017-10-29 12:08:24 -04:00
Brad Parker
0a1b3fedc0 VC6 support (targets NT 3.51) 2017-09-06 23:03:02 -04:00
twinaphex
47b4de7bbf Update 2017-09-06 23:17:00 +02:00
twinaphex
57514668f3 Revert "Update"
This reverts commit af3b2f22ec8bdf66ef843b408d72f7bfebcf2dc2.
2017-06-24 23:15:16 +02:00
twinaphex
af3b2f22ec Update 2017-06-24 23:05:29 +02:00
twinaphex
e6ee2527e5 Add filestream_get_size/filestream_set_size 2017-02-18 02:21:33 +01:00
twinaphex
e9524f1b95 Add filestream_get_ext 2017-02-18 02:16:40 +01:00
twinaphex
7a5ed7cc65 Add filestream_flush and use filestream interface for tasks/task_save.c 2017-02-17 03:03:18 +01:00
twinaphex
64bb848daf Update headers (pt. 2 - libretro-common) 2017-01-22 13:58:20 +01:00