Ozkan Sezer
45a6ad8e57
wikiheaders.pl: make it work with older perl versions, e.g. 5.10.
2023-03-24 11:56:40 +03:00
Ryan C. Gordon
0a0dfdb2f9
wikiheaders: Sort pages before listing them in README/FrontPage.md.
...
(cherry picked from commit 99c38268cd1325bb64739217adbeebaae7ae6a84)
2023-02-28 12:29:21 -05:00
Ryan C. Gordon
8572e19327
wikiheaders: Use Windows endlines in the source, Unix in the wiki.
...
(cherry picked from commit 7745c9b3ae3f2f47e2b3e55399afc5e7b86c0102)
2023-02-28 12:29:16 -05:00
Ryan C. Gordon
462d95ab4d
wikiheaders: ignore wiki's README/FrontPage.md
...
(cherry picked from commit 6d1e14b7924e45937941a64bcaf751e17b41a8e9)
2023-02-28 11:56:20 -05:00
Ryan C. Gordon
a48bb80ea0
wikiheaders: Bridge README files in the docs directory to wiki.
...
Fixes #6026 .
(cherry picked from commit 2506676f34dc9d3e64ab7bbd9c947b8c13364913)
2023-02-28 11:46:46 -05:00
Ryan C. Gordon
37de5d4849
wikiheaders: fixed wikilinks in Markdown code sections.
...
(cherry picked from commit a4796334550da0963ed957829f41b9499a472d73)
2023-02-27 23:08:55 -05:00
Ryan C. Gordon
171fba320f
wikiheaders: Fix wikilinks inside code sections a little. Not perfect yet.
...
(cherry picked from commit 5b0351a672701e28c3bfb17d44a458b82e8a4175)
2023-02-24 14:30:34 -05:00
Ryan C. Gordon
858ae9900e
wikiheaders: fixed see-also conversion
...
(cherry picked from commit d748a454a86d6250b724fe94066eb98fbf4eea05)
2023-02-24 11:46:41 -05:00
Ryan C. Gordon
f87f0fe781
wikibridge: Fixes for manpage generation from Markdown format.
...
(cherry picked from commit 5ff49955ab71121ffbc49eb6a7be69707cbd90f3)
2023-02-24 10:22:28 -05:00
Ryan C. Gordon
b3ea81b33f
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.
(cherry picked from commit 936a51d5cc50afd76e291acd36bcb95513ce8919)
2023-02-24 09:48:37 -05:00
Ryan C. Gordon
d5680c5d20
wikiheaders: Allow markdown in the wikipreamble string.
...
Reference Issue #6568 .
(cherry picked from commit a089b2ea19404f6dacd083327e13cae888b58993)
2023-01-26 10:23:21 -05:00
Ryan C. Gordon
1069c8931d
wikiheaders: Add a \threadsafety tag to document threading details.
...
Reference Issue #7140 .
(cherry picked from commit 01cba48d18f9002e5aae66d4b009f5f0195dc8d7)
2023-01-26 10:23:08 -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
Ryan C. Gordon
d9d8f51eec
wikiheaders.pl: Add support for deprecated functions.
2021-10-23 14:41:23 -04:00
Ryan C. Gordon
55f60847cb
wikiheaders.pl: Try to handle functions with multiple declarations better.
2021-10-08 20:50:30 -04:00
Ryan C. Gordon
3970a885a5
wikiheaders.pl: Migrate in docs that exist only in the wiki.
...
This is going to expose some docs that needs cleaning up once
the bridge imports those docs, though.
2021-10-08 15:58:02 -04:00
Ryan C. Gordon
7def81cf42
wikiheaders.pl: Don't treat chars in code blocks as markdown.
...
Otherwise a formula like `x = y * 2;` would treat that '*' as the start of
an italicized section when converting to MediaWiki format, and match any
other '*' in the content as the end marker.
2021-09-30 17:34:25 -04:00
Ryan C. Gordon
8796f35e0f
wikiheaders.pl: Make sure all wiki API pages reference CategoryAPI.
2021-09-01 00:19:54 -04:00
Ryan C. Gordon
c07e5e99c8
wikiheaders.pl: Add --copy-to-header option.
...
...because I keep mistyping it without the 's' on the end. :/
2021-07-14 17:07:41 -04:00
Ryan C. Gordon
8ec9fbdd0c
wikiheaders.pl: pull in full sections from headers, fix more whitespace.
2021-07-14 11:58:57 -04:00
Ryan C. Gordon
bab0eb71ce
wikiheaders.pl: Fix some wordwrap whitespace issues.
2021-07-14 11:03:00 -04:00
Ryan C. Gordon
7390bc0e5e
wikiheaders.pl: Fix \sa tags that (incorrectly!) have "()" appended.
2021-07-14 11:03:00 -04:00
Ryan C. Gordon
d115857c6f
wikiheaders.pl: A bunch of work on correct wordwrap and (de)wikify.
2021-07-14 11:02:59 -04:00
Ryan C. Gordon
1f17bc549e
wikiheaders: look for "c++" before "c" in regular expression.
2021-07-14 11:02:59 -04:00
Ryan C. Gordon
269d0773c7
wikiheaders: Ignore doxygen comments that aren't "/**" on a line by itself.
...
Makes this ignore /** single line comments */
2021-07-14 11:02:58 -04:00
Ryan C. Gordon
8130950e92
wikiheaders: trim whitespace at edges after wordwrapping.
2021-07-14 11:02:58 -04:00
Ryan C. Gordon
ab7944f960
wikiheaders: fixed regex for converting markdown bold+italic to mediawiki.
2021-03-25 12:52:15 -04:00
Ryan C. Gordon
f55445422a
wikiheaders: when merging into headers, wordwrap in Markdown style.
2021-03-25 12:50:18 -04:00
Ryan C. Gordon
45d128db00
wikiheaders: Fixed double-wikify call.
2021-03-24 22:36:06 -04:00
Ryan C. Gordon
5753fd73c3
wikiheaders.pl: Whitespace fixes.
2021-03-24 12:52:48 -04:00
Ryan C. Gordon
c2152928fa
wikiheaders.pl: Mark some sections as wiki-only so we don't lose them.
2021-03-24 10:48:45 -04:00
Ryan C. Gordon
231b849c9e
wikiheaders.pl: Properly handle and wordwrap bullet lists.
2021-03-24 10:48:44 -04:00
Ryan C. Gordon
7a2a1a85e9
documentation: initial script to merge header comments and the wiki.
...
This is a work-in-progress, but the idea is it can convert between our
wiki and the SDL header's doxygen comments, so we can attempt to keep them
in sync.
This might be a fool's errand, but I'm optimistic it'll work enough that we
can clean up little issues as we go, as long as we have some discipline
about how we write documentation. If nothing else, it's going to result in
a solid spring-cleaning of both the wiki and the headers!
2021-03-16 13:49:35 -04:00
