120 Commits

Author	SHA1	Message	Date
Ryan C. Gordon	9f842e9b5a	wikiheaders: Bind #defines below a function to it, like typedefs. ... This effectively adds the property symbols for various functions to the function's wiki page.	2024-05-02 12:49:30 -04:00
Ryan C. Gordon	eb2c9e9235	wikiheaders: added --report-coverage-gaps to see what we aren't covering!	2024-05-01 19:58:21 -04:00
Ryan C. Gordon	12b6c17575	wikiheaders: Generate wiki pages for defines under a typedef. ... These are just there to handle cases where a user stumbles upon a symbol and punches it into the wiki, so they don't get a 404 for it, but rather a pointer to where that symbol is relevant. These pages are generated in the wiki if they don't exist, and are never overwritten, in case text has been added to them. They are also not bridged back to the headers or added to the set of manpages.	2024-04-30 22:47:02 -04:00
Ryan C. Gordon	5481ea4cd4	wikiheaders: manpages See Also sections should specify 3 vs 3type.	2024-04-30 21:46:56 -04:00
Ryan C. Gordon	9210c68c44	wikiheaders: Manpages go in man3 directory, even if they're 3type.	2024-04-30 21:46:56 -04:00
Ryan C. Gordon	2ee1c87eb0	wikiheaders: Fixed preprocessor line check to include #endif. ... Reference Issue #9557.	2024-04-25 16:46:43 -04:00
Ryan C. Gordon	6b1a98e664	wikiheaders: Allow basic typedefs to pull in some preprocessor logic. ... Reference Issue #9557. This lets SDL_AudioFormat have the `#if byteorder == lilendian` section.	2024-04-25 16:44:09 -04:00
Ryan C. Gordon	d29b861a76	wikiheaders: Allow blank lines in post-typedef #define blocks. ... Reference Issue #9557.	2024-04-25 14:26:49 -04:00
Ryan C. Gordon	2fb024ab8e	wikiheaders: Defines directly following a non-struct typedef are documented. ... The idea is that if you have a `typedef Uint32 MyFlags` that has a bunch of defines that are meant to be bitflags, you can pack them into the same wiki page automatically. This only works with `typedef`s that are _not_ struct/union/enums, and it only pulls in `#define` lines that immediately follow the typedef line. Even a blank line or a comment will signal to stop including lines for this page!	2024-04-25 03:02:27 -04:00
Ryan C. Gordon	21bc72bef1	wikiheaders: Allow parts of the headers to be ignored. ... The specific cases here were SDL_size_mul_overflow_builtin and SDL_size_add_overflow_builtin, which are forced-inline symbols in SDL_stdinc.h that have to exist, but aren't really part of the public API, and thus shouldn't be exported as documentation.	2024-04-13 22:57:23 -04:00
Ryan C. Gordon	3c86af5901	wikiheaders: Add support for SDL_FORCE_INLINE functions.	2024-04-13 20:08:14 -04:00
Ryan C. Gordon	0df988389c	include: Add \since to all documentation that was missing it.	2024-04-11 13:34:29 -04:00
Ryan C. Gordon	af6a4a9e38	wikiheaders: Fixed a silly logic bug.	2024-04-11 08:57:50 -04:00
Ryan C. Gordon	6ccdfffe26	wikiheaders: Fixes to manpage output for datatypes vs functions.	2024-04-11 01:03:07 -04:00
Ryan C. Gordon	5a58b3d97a	wikiheaders: Bridge basic typedefs to the wiki!	2024-04-11 00:37:11 -04:00
Ryan C. Gordon	645073961d	wikiheaders: Don't mangle Markdown tables in wordwrap.	2024-04-09 00:50:02 -04:00
Ryan C. Gordon	a25d49c162	wikiheaders: Bridge structs, unions, and enums to the wiki!	2024-04-09 00:50:02 -04:00
Ryan C. Gordon	125bbc5e61	wikiheaders: Fixed usage of die(). ... (if there's a newline in the output, it won't print the line in the Perl script where the failure happened, so fix this in places where it's used more like an assert than error reporting.)	2024-04-09 00:50:02 -04:00
Ryan C. Gordon	34f4484f48	wikiheaders: Renamed "Related Functions" section to "See Also" ... It's not all functions now!	2024-04-09 00:50:01 -04:00
Ryan C. Gordon	dd2780f9fb	wikiheaders: Remove trailing whitespace from "brief" description.	2024-04-09 00:50:01 -04:00
Ryan C. Gordon	a26ec343c3	wikiheaders: Bridge macros to the wiki!	2024-04-09 00:50:01 -04:00
Ryan C. Gordon	e055a9fc2d	wikiheaders.pl: Report a function's header file name.	2024-03-31 12:56:00 -04:00
Ryan C. Gordon	df0fd55891	wikiheaders.pl: README files are no longer in Windows endline format.	2023-11-30 10:10:04 -05:00
Ryan C. Gordon	ce27363df2	wikiheaders: Sort undocumented functions. ... Otherwise they appear in random order, which isn't ideal in general, but also this breaks the wiki/header bridge because it can't produce identical conversions per-run.	2023-09-12 09:58:10 -04:00
Anonymous Maarten	b00cbd76aa	wikiheaders.pl: create Unsupported.md file with list of functions undocumented in either the headers or the wiki	2023-09-06 15:51:08 -04:00
Anonymous Maarten	e85206ffd8	wikiheaders.pl: add --rev= option to pass revision string ... This way, git is not required anymore to calculate the git revision	2023-09-04 18:56:00 +02:00
Sam Lantinga	1f095b9ce6	Fixed wikiheaders.pl with perl-5.10.1 (thanks @sezero!)	2023-03-24 13:57:24 -07:00
Ryan C. Gordon	586004e52a	wikiheaders.pl: Manpages shouldn't use .BI sections, it looks bad. ... Reference Issue #7514.	2023-03-21 22:23:06 -07:00
Ryan C. Gordon	1b81ececd3	wikiheaders.pl: Fixed uninitialized value warning when run without arguments.	2023-03-21 21:57:12 -07:00
Anonymous Maarten	77b8edb5ad	wikiheaders.pl: add --manpath argument	2023-03-21 02:19:19 +01:00
Ryan C. Gordon	99c38268cd	wikiheaders: Sort pages before listing them in README/FrontPage.md.	2023-02-28 12:28:10 -05:00
Ryan C. Gordon	7745c9b3ae	wikiheaders: Use Windows endlines in the source, Unix in the wiki.	2023-02-28 12:28:10 -05:00
Ryan C. Gordon	6d1e14b792	wikiheaders: ignore wiki's README/FrontPage.md	2023-02-28 11:55:19 -05:00
Ryan C. Gordon	2506676f34	wikiheaders: Bridge README files in the docs directory to wiki. ... Fixes #6026.	2023-02-28 11:45:47 -05:00
Ryan C. Gordon	a479633455	wikiheaders: fixed wikilinks in Markdown code sections.	2023-02-27 23:08:19 -05:00
Ryan C. Gordon	5b0351a672	wikiheaders: Fix wikilinks inside code sections a little. Not perfect yet.	2023-02-24 14:29:36 -05:00
Ryan C. Gordon	d748a454a8	wikiheaders: fixed see-also conversion	2023-02-24 11:45:43 -05:00
Ryan C. Gordon	5ff49955ab	wikibridge: Fixes for manpage generation from Markdown format.	2023-02-24 10:21:54 -05:00
Ryan C. Gordon	936a51d5cc	wikiheaders: Work to make the wiki exist primarily in Markdown format. ... This adds a means to mass-convert the whole wiki to Markdown as a one-time operation, and then some fixes to make --copy-to-headers correctly deal with Markdown-formatted wiki pages.	2023-02-24 09:07:09 -05:00
Ryan C. Gordon	726d6f9422	wikiheaders: Allow markdown in the wikipreamble string. ... Reference Issue #6568.	2023-01-26 14:45:57 -05:00
Ryan C. Gordon	01cba48d18	wikiheaders: Add a \threadsafety tag to document threading details. ... Reference Issue #7140.	2023-01-25 12:59:25 -05:00
Ryan C. Gordon	118a2189fb	build-scripts/wikiheaders.pl: ignore the 'FrontPage' wiki pages.	2022-06-23 16:07:35 -04:00
Ryan C. Gordon	48a232969d	wikiheaders: Strip [[wiki hyperlink]] from See Also fields.	2022-06-19 00:15:41 -04:00
Ryan C. Gordon	83b766174c	build-scripts/wikiheaders.pl: ignore "Category" wiki pages.	2022-06-17 17:35:52 -04:00
Ryan C. Gordon	20c622f090	build-scripts/wikiheaders.pl: Allow a wiki preamble. ... This is so we can have everything in SDL_net (etc) start with a "This is not part of the core SDL API" message.	2022-06-17 14:40:35 -04:00
Ryan C. Gordon	94f6080895	wikiheaders.pl: changes to make this usable with external projects.	2022-06-15 23:26:24 -04:00
Ryan C. Gordon	bed96482fa	wikiheaders.pl: Deal with links better.	2022-05-25 10:42:11 -04:00
Ryan C. Gordon	96a04cb910	wikiheaders.pl: Don't wordwrap truly massive words. ... Usually, these are going to be URLs that you don't want to split across lines.	2022-05-25 09:30:29 -04:00
Ryan C. Gordon	f62b807174	wikiheaders.pl: Put the manpages in man/man3	2022-01-07 21:39:10 -05:00
Ryan C. Gordon	5d3f6b0215	wikiheaders.pl: Added support for export to Unix manpages. ... This mostly works, but likely needs some tweaking as we examine the output of various pages. Fixes #5163.	2022-01-06 15:37:05 -05:00