Skip to content

Commit

Permalink
Fix the _ doc hiding name.
Browse files Browse the repository at this point in the history
  • Loading branch information
Y_Less committed Nov 8, 2022
1 parent 7e108aa commit 1249b64
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
4 changes: 2 additions & 2 deletions YSI_Core/y_core/y_pawndoc_with_fixes.inc
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Optional plugins:
This variable only exists to re-show other variables. It ends a tiny
comment in the output XML started by fixes.inc with the immediately
preceeding variable (which should be called
<c>ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZY</c>) so that we can document several
<c>Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzy</c>) so that we can document several
seemingly "internal" variables that are actually for end-user use
(<c>_0</c> - <c>_9</c>). We then re-start the block comment to have it
ended again later by the original fixes.inc end variable
Expand All @@ -93,5 +93,5 @@ Optional plugins:
-->
*/

static stock ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ;
static stock Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz;

8 changes: 4 additions & 4 deletions YSI_Core/y_core/y_pawndoc_without_fixes.inc
Original file line number Diff line number Diff line change
Expand Up @@ -222,10 +222,10 @@ _FIXES_FUNC_PAWNDOC(ENUM_PAWNDOC(const symbol[]));
still see one function (this one), but at least the documentation for
this one function can explain why it exists.
<p />
This is <c>ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ</c> and starts the internal
This is <c>Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz</c> and starts the internal
functions block. This is the last possible name before the first
character is <c>_</c> when the functions are sorted lexicographically
(alphabetically). There's also <c>ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZY</c>
(alphabetically). There's also <c>Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzy</c>
that starts the variables block; they could have the same name if they
were not declared in the same scope, but they might not always be
separately defined.
Expand All @@ -237,7 +237,7 @@ _FIXES_FUNC_PAWNDOC(ENUM_PAWNDOC(const symbol[]));
<!--
*/

static stock ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ() {}
static stock Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz() {}

/**
<hidden />
Expand All @@ -248,7 +248,7 @@ static stock ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ() {}
common pattern used throughout YSI (and most of programming).
Unfortunately these weirdly named internal functions appear in the
generated documentation always. This is the best way to hide them. You
still see one function (<c>ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ</c>), but at
still see one function (<c>Zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz</c>), but at
least the documentation for that can explain why it exists.
<p />
This is <c>_zzzzzzzzzzzzzzzzzzzzzzzzzzzzzz</c> and ends the internal
Expand Down
2 changes: 1 addition & 1 deletion amx
Submodule amx updated from 507b72 to b303a8
2 changes: 1 addition & 1 deletion code-parse
Submodule code-parse updated 1 files
+8 −0 api.md
2 changes: 1 addition & 1 deletion indirection
Submodule indirection updated 1 files
+522 −0 api.md

0 comments on commit 1249b64

Please sign in to comment.