Skip to content

Commit 6870775

Browse files
authored
Generate docs index from header file structure (#6)
Use Clang JSON to navigate and xref the header files to the Swift types. Add to J2 and DocC docs metadata.
1 parent 92c39fb commit 6870775

File tree

530 files changed

+465632
-356584
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

530 files changed

+465632
-356584
lines changed

.jazzy.yaml

+693-28
Large diffs are not rendered by default.

.spi.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
version: 1
2+
builder:
3+
configs:
4+
- documentation_targets: [Steamworks, SteamworksHelpers, SteamworksEncryptedAppTicket]

DocIndex/docc-custom-topics.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Topics
2+
3+
### API Clients
4+
- ``SteamBaseAPI``
5+
- ``SteamAPI``
6+
- ``SteamGameServerAPI``
7+
- ``SteamEncryptedAppTicket``
8+
### Interfaces
9+
- <doc:SteamAppList-Interface>
10+
- <doc:SteamApps-Interface>
11+
- <doc:SteamFriends-Interface>
12+
- <doc:SteamGameSearch-Interface>
13+
- <doc:SteamGameServer-Interface>
14+
- <doc:SteamGameServerStats-Interface>
15+
- <doc:SteamHTMLSurface-Interface>
16+
- <doc:SteamHTTP-Interface>
17+
- <doc:SteamInput-Interface>
18+
- <doc:SteamInventory-Interface>
19+
- <doc:SteamMatchmaking-Interface>
20+
- <doc:SteamMatchmakingServers-Interface>
21+
- <doc:SteamMusic-Interface>
22+
- <doc:SteamMusicRemote-Interface>
23+
- <doc:SteamNetworkingMessages-Interface>
24+
- <doc:SteamNetworkingSockets-Interface>
25+
- <doc:SteamNetworkingUtils-Interface>
26+
- <doc:SteamParentalSettings-Interface>
27+
- <doc:SteamParties-Interface>
28+
- <doc:SteamRemotePlay-Interface>
29+
- <doc:SteamRemoteStorage-Interface>
30+
- <doc:SteamScreenshots-Interface>
31+
- <doc:SteamUGC-Interface>
32+
- <doc:SteamUser-Interface>
33+
- <doc:SteamUserStats-Interface>
34+
- <doc:SteamUtils-Interface>
35+
- <doc:SteamVideo-Interface>
36+
### Common Types
37+
- <doc:Common-Types>
38+
- ``SteamConstants``

0 commit comments

Comments
 (0)