mirror of https://github.com/marrub--/zscript-doc
organize into folders (why didn't i think of this sooner?)
parent
b7f8614ab4
commit
94e70bd557
126
api.md
126
api.md
|
@ -26,7 +26,7 @@ modder rather than for the engine.
|
|||
|
||||
<!-- inter-toc actor -->
|
||||
|
||||
* [State](api-actor-State.md)
|
||||
* [State](api/actor/State.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -36,15 +36,15 @@ TODO
|
|||
|
||||
<!-- inter-toc base -->
|
||||
|
||||
* [Array](api-base-Array.md)
|
||||
* [Color](api-base-Color.md)
|
||||
* [CVar](api-base-CVar.md)
|
||||
* [FixedArray](api-base-FixedArray.md)
|
||||
* [Object](api-base-Object.md)
|
||||
* [String](api-base-String.md)
|
||||
* [StringTable](api-base-StringTable.md)
|
||||
* [Thinker](api-base-Thinker.md)
|
||||
* [Vector](api-base-Vector.md)
|
||||
* [Array](api/base/Array.md)
|
||||
* [CVar](api/base/CVar.md)
|
||||
* [Color](api/base/Color.md)
|
||||
* [FixedArray](api/base/FixedArray.md)
|
||||
* [Object](api/base/Object.md)
|
||||
* [StringTable](api/base/StringTable.md)
|
||||
* [String](api/base/String.md)
|
||||
* [Thinker](api/base/Thinker.md)
|
||||
* [Vector](api/base/Vector.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -54,14 +54,14 @@ TODO
|
|||
|
||||
<!-- inter-toc drawing -->
|
||||
|
||||
* [BrokenLines](api-drawing-BrokenLines.md)
|
||||
* [Console](api-drawing-Console.md)
|
||||
* [Font](api-drawing-Font.md)
|
||||
* [GIFont](api-drawing-GIFont.md)
|
||||
* [Screen](api-drawing-Screen.md)
|
||||
* [Shape2D](api-drawing-Shape2D.md)
|
||||
* [TexMan](api-drawing-TexMan.md)
|
||||
* [TextureID](api-drawing-TextureID.md)
|
||||
* [BrokenLines](api/drawing/BrokenLines.md)
|
||||
* [Console](api/drawing/Console.md)
|
||||
* [Font](api/drawing/Font.md)
|
||||
* [GIFont](api/drawing/GIFont.md)
|
||||
* [Screen](api/drawing/Screen.md)
|
||||
* [Shape2D](api/drawing/Shape2D.md)
|
||||
* [TexMan](api/drawing/TexMan.md)
|
||||
* [TextureID](api/drawing/TextureID.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -71,11 +71,11 @@ TODO
|
|||
|
||||
<!-- inter-toc events -->
|
||||
|
||||
* [ConsoleEvent](api-events-ConsoleEvent.md)
|
||||
* [EventHandler](api-events-EventHandler.md)
|
||||
* [RenderEvent](api-events-RenderEvent.md)
|
||||
* [ReplaceEvent](api-events-ReplaceEvent.md)
|
||||
* [StaticEventHandler](api-events-StaticEventHandler.md)
|
||||
* [ConsoleEvent](api/events/ConsoleEvent.md)
|
||||
* [EventHandler](api/events/EventHandler.md)
|
||||
* [RenderEvent](api/events/RenderEvent.md)
|
||||
* [ReplaceEvent](api/events/ReplaceEvent.md)
|
||||
* [StaticEventHandler](api/events/StaticEventHandler.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -85,7 +85,7 @@ TODO
|
|||
|
||||
<!-- inter-toc files -->
|
||||
|
||||
* [Wads](api-files-Wads.md)
|
||||
* [Wads](api/files/Wads.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -95,11 +95,11 @@ TODO
|
|||
|
||||
<!-- inter-toc inter -->
|
||||
|
||||
* [InterBackground](api-inter-InterBackground.md)
|
||||
* [PatchInfo](api-inter-PatchInfo.md)
|
||||
* [StatusScreen](api-inter-StatusScreen.md)
|
||||
* [WBPlayerStruct](api-inter-WBPlayerStruct.md)
|
||||
* [WBStartStruct](api-inter-WBStartStruct.md)
|
||||
* [InterBackground](api/inter/InterBackground.md)
|
||||
* [PatchInfo](api/inter/PatchInfo.md)
|
||||
* [StatusScreen](api/inter/StatusScreen.md)
|
||||
* [WBPlayerStruct](api/inter/WBPlayerStruct.md)
|
||||
* [WBStartStruct](api/inter/WBStartStruct.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -115,17 +115,17 @@ for [statistics drivers][1].
|
|||
|
||||
<!-- inter-toc level -->
|
||||
|
||||
* [F3DFloor](api-level-F3DFloor.md)
|
||||
* [FColorMap](api-level-FColorMap.md)
|
||||
* [Line](api-level-Line.md)
|
||||
* [LineIdIterator](api-level-LineIdIterator.md)
|
||||
* [SecPlane](api-level-SecPlane.md)
|
||||
* [SecSpecial](api-level-SecSpecial.md)
|
||||
* [Sector](api-level-Sector.md)
|
||||
* [SectorEffect](api-level-SectorEffect.md)
|
||||
* [SectorTagIterator](api-level-SectorTagIterator.md)
|
||||
* [Side](api-level-Side.md)
|
||||
* [Vertex](api-level-Vertex.md)
|
||||
* [F3DFloor](api/level/F3DFloor.md)
|
||||
* [FColorMap](api/level/FColorMap.md)
|
||||
* [LineIdIterator](api/level/LineIdIterator.md)
|
||||
* [Line](api/level/Line.md)
|
||||
* [SecPlane](api/level/SecPlane.md)
|
||||
* [SecSpecial](api/level/SecSpecial.md)
|
||||
* [SectorEffect](api/level/SectorEffect.md)
|
||||
* [SectorTagIterator](api/level/SectorTagIterator.md)
|
||||
* [Sector](api/level/Sector.md)
|
||||
* [Side](api/level/Side.md)
|
||||
* [Vertex](api/level/Vertex.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -135,9 +135,9 @@ TODO
|
|||
|
||||
<!-- inter-toc player -->
|
||||
|
||||
* [PlayerClass](api-player-PlayerClass.md)
|
||||
* [PlayerSkin](api-player-PlayerSkin.md)
|
||||
* [Team](api-player-Team.md)
|
||||
* [PlayerClass](api/player/PlayerClass.md)
|
||||
* [PlayerSkin](api/player/PlayerSkin.md)
|
||||
* [Team](api/player/Team.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -147,7 +147,7 @@ TODO
|
|||
|
||||
<!-- inter-toc sound -->
|
||||
|
||||
* [SeqNode](api-sound-SeqNode.md)
|
||||
* [SeqNode](api/sound/SeqNode.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -157,7 +157,7 @@ TODO
|
|||
|
||||
<!-- inter-toc wep -->
|
||||
|
||||
* [PSprite](api-wep-PSprite.md)
|
||||
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
@ -165,39 +165,39 @@ TODO
|
|||
|
||||
# Global Objects
|
||||
|
||||
<!-- inter-toc global-data -->
|
||||
<!-- inter-toc global/data -->
|
||||
|
||||
* [Client](api-global-data-Client.md)
|
||||
* [Constants](api-global-data-Constants.md)
|
||||
* [Game](api-global-data-Game.md)
|
||||
* [Information](api-global-data-Information.md)
|
||||
* [Player](api-global-data-Player.md)
|
||||
* [Client](api/global/data/Client.md)
|
||||
* [Constants](api/global/data/Constants.md)
|
||||
* [Game](api/global/data/Game.md)
|
||||
* [Information](api/global/data/Information.md)
|
||||
* [Player](api/global/data/Player.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
These variables are accessible in any context and are not bound by any specific
|
||||
object. Generally these mirror global information within the engine itself.
|
||||
|
||||
<!-- inter-toc global-func -->
|
||||
<!-- inter-toc global/func -->
|
||||
|
||||
* [Classes](api-global-func-Classes.md)
|
||||
* [Game](api-global-func-Game.md)
|
||||
* [Math](api-global-func-Math.md)
|
||||
* [Random](api-global-func-Random.md)
|
||||
* [Sound](api-global-func-Sound.md)
|
||||
* [System](api-global-func-System.md)
|
||||
* [Classes](api/global/func/Classes.md)
|
||||
* [Game](api/global/func/Game.md)
|
||||
* [Math](api/global/func/Math.md)
|
||||
* [Random](api/global/func/Random.md)
|
||||
* [Sound](api/global/func/Sound.md)
|
||||
* [System](api/global/func/System.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
These functions are accessible in any context and are not bound by any specific
|
||||
object. Generally these are utility functions.
|
||||
|
||||
<!-- inter-toc global-type -->
|
||||
<!-- inter-toc global/type -->
|
||||
|
||||
* [DehInfo](api-global-type-DehInfo.md)
|
||||
* [FOptionMenuSettings](api-global-type-FOptionMenuSettings.md)
|
||||
* [GameInfoStruct](api-global-type-GameInfoStruct.md)
|
||||
* [LevelLocals](api-global-type-LevelLocals.md)
|
||||
* [DehInfo](api/global/type/DehInfo.md)
|
||||
* [FOptionMenuSettings](api/global/type/FOptionMenuSettings.md)
|
||||
* [GameInfoStruct](api/global/type/GameInfoStruct.md)
|
||||
* [LevelLocals](api/global/type/LevelLocals.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
|
10
glossary.md
10
glossary.md
|
@ -2,11 +2,11 @@
|
|||
|
||||
<!-- inter-toc -->
|
||||
|
||||
* [Classes](glossary-Classes.md)
|
||||
* [Concepts](glossary-Concepts.md)
|
||||
* [Structures](glossary-Structures.md)
|
||||
* [Style](glossary-Style.md)
|
||||
* [Versions](glossary-Versions.md)
|
||||
* [Classes](glossary/Classes.md)
|
||||
* [Concepts](glossary/Concepts.md)
|
||||
* [Structures](glossary/Structures.md)
|
||||
* [Style](glossary/Style.md)
|
||||
* [Versions](glossary/Versions.md)
|
||||
|
||||
<!-- end -->
|
||||
|
||||
|
|
|
@ -127,15 +127,15 @@ Finally, here is a table of contents for each language element:
|
|||
|
||||
<!-- inter-toc -->
|
||||
|
||||
* [Classes](lang-Classes.md)
|
||||
* [Constants](lang-Constants.md)
|
||||
* [Enumerations](lang-Enumerations.md)
|
||||
* [Expressions](lang-Expressions.md)
|
||||
* [Members](lang-Members.md)
|
||||
* [Methods](lang-Methods.md)
|
||||
* [Statements](lang-Statements.md)
|
||||
* [Structures](lang-Structures.md)
|
||||
* [Types](lang-Types.md)
|
||||
* [Classes](language/Classes.md)
|
||||
* [Constants](language/Constants.md)
|
||||
* [Enumerations](language/Enumerations.md)
|
||||
* [Expressions](language/Expressions.md)
|
||||
* [Members](language/Members.md)
|
||||
* [Methods](language/Methods.md)
|
||||
* [Statements](language/Statements.md)
|
||||
* [Structures](language/Structures.md)
|
||||
* [Types](language/Types.md)
|
||||
|
||||
<!-- end -->
|
||||
|
|
@ -3,55 +3,62 @@
|
|||
## By Alison Sanderson. Attribution is encouraged, though not required.
|
||||
## <https://creativecommons.org/publicdomain/zero/1.0/legalcode>
|
||||
## TOCGen: Generates inter-file TOCs.
|
||||
## Example usage:
|
||||
## tools/tocgen.rb
|
||||
|
||||
$d = Dir["*.md"]
|
||||
def emit_filtered_file_toc file_matcher
|
||||
links = []
|
||||
files = ALL_MD_FILES.map do |p| p.match file_matcher end.compact
|
||||
|
||||
def filter_emit r
|
||||
res = []
|
||||
for m in $d.map{|p| p.match r}.compact
|
||||
res << "* [#{m[1]}](#{m[0]})"
|
||||
for md_file in files
|
||||
links << "* [#{md_file[1]}](#{md_file[0]})"
|
||||
end
|
||||
res.join ?\n
|
||||
|
||||
links.sort.join ?\n
|
||||
end
|
||||
|
||||
def find_toc_areas f
|
||||
re = /^(<!-- inter-toc\s*([^\s]+)\s*-->)(?:.|\n)*?(<!-- end -->)/i
|
||||
f.to_enum(:scan, re).map{$~}
|
||||
TOC_REGEX = /^(<!-- inter-toc\s*([^\s]+)?\s*-->)(?:.|\n)*?(<!-- end -->)/i
|
||||
def find_inter_toc_areas file
|
||||
file.to_enum(:scan, TOC_REGEX).map do $~ end
|
||||
end
|
||||
|
||||
def filter_toc_areas f
|
||||
o = String.new
|
||||
lof = 0
|
||||
for area in find_toc_areas f
|
||||
of = area.offset 0
|
||||
o << f[lof...of[0]]
|
||||
o << area[1]
|
||||
o << "\n\n"
|
||||
o << filter_emit(yield area[2])
|
||||
o << "\n\n"
|
||||
o << area[3]
|
||||
lof = of[1]
|
||||
def filter_toc_areas file
|
||||
content = ""
|
||||
last_offset = 0
|
||||
|
||||
for area in find_inter_toc_areas file
|
||||
offset = area.offset 0
|
||||
content << file[last_offset...offset[0]]
|
||||
content << area[1]
|
||||
content << "\n\n"
|
||||
content << emit_filtered_file_toc(yield area[2])
|
||||
content << "\n\n"
|
||||
content << area[3]
|
||||
last_offset = offset[1]
|
||||
end
|
||||
o << f[lof..-1]
|
||||
o
|
||||
|
||||
content << file[last_offset..-1]
|
||||
content
|
||||
end
|
||||
|
||||
def rewrite fnam
|
||||
f = File.read fnam
|
||||
o = yield f
|
||||
File.write fnam, o
|
||||
def rewrite filename
|
||||
file = File.read filename
|
||||
output = yield file
|
||||
File.write filename, output
|
||||
end
|
||||
|
||||
rewrite "api.md" do |f|
|
||||
filter_toc_areas f do |a| /api-#{a}-(\w+).md/ end
|
||||
ALL_MD_FILES = Dir["{api,glossary,language}/**/*.md"]
|
||||
|
||||
rewrite "api.md" do |file|
|
||||
filter_toc_areas file do |folder| /api\/#{folder}\/(\w+).md/ end
|
||||
end
|
||||
|
||||
rewrite "glossary.md" do |f|
|
||||
filter_toc_areas f do |a| /glossary-(\w+).md/ end
|
||||
rewrite "glossary.md" do |file|
|
||||
filter_toc_areas file do |_| /glossary\/(\w+).md/ end
|
||||
end
|
||||
|
||||
rewrite "lang.md" do |f|
|
||||
filter_toc_areas f do |a| /lang-(\w+).md/ end
|
||||
rewrite "language.md" do |file|
|
||||
filter_toc_areas file do |_| /language\/(\w+).md/ end
|
||||
end
|
||||
|
||||
## EOF
|
||||
|
|
|
@ -10,45 +10,45 @@
|
|||
|
||||
require "./tools/zsclasstree.rb"
|
||||
|
||||
DIR = ARGV.shift
|
||||
VER = ARGV.shift
|
||||
FILES = ARGV.shift
|
||||
VERSION = ARGV.shift
|
||||
|
||||
si = ClassSiphon.new DIR
|
||||
siphon = ClassSiphon.new FILES
|
||||
|
||||
f = open "glossary-Classes.md", "wb"
|
||||
f.puts <<_end_
|
||||
file = open "glossary-Classes.md", "wb"
|
||||
file.puts <<_end_
|
||||
# Classes
|
||||
|
||||
Here is a full tree of all classes in ZScript as of GZDoom #{VER}. There are
|
||||
#{si.classes.count + 1} classes total.
|
||||
Here is a full tree of all classes in ZScript as of GZDoom #{VERSION}. There
|
||||
are #{siphon.classes.count + 1} classes total.
|
||||
|
||||
```
|
||||
Object
|
||||
_end_
|
||||
|
||||
si.print_classes f
|
||||
siphon.print_classes file
|
||||
|
||||
f.puts <<_end_
|
||||
file.puts <<_end_
|
||||
```
|
||||
|
||||
<!-- EOF -->
|
||||
_end_
|
||||
|
||||
f = open "glossary-Structures.md", "wb"
|
||||
f.puts <<_end_
|
||||
file = open "glossary-Structures.md", "wb"
|
||||
file.puts <<_end_
|
||||
# Structures
|
||||
|
||||
Here is a full list of all structures in ZScript as of GZDoom #{VER}. There are
|
||||
#{si.structs.count} structures total. Note that some of these are merely
|
||||
implementation details and should not be used in code.
|
||||
Here is a full list of all structures in ZScript as of GZDoom #{VERSION}.
|
||||
There are #{siphon.structs.count} structures total. Note that some of these
|
||||
are merely implementation details and should not be used in code.
|
||||
|
||||
```
|
||||
Struct
|
||||
_end_
|
||||
|
||||
si.print_structs f
|
||||
siphon.print_structs file
|
||||
|
||||
f.puts <<_end_
|
||||
file.puts <<_end_
|
||||
```
|
||||
|
||||
<!-- EOF -->
|
||||
|
|
Loading…
Reference in New Issue