Skip to content

Website: API documentation page#4040

Merged
swharden merged 11 commits intomainfrom
3822-api-docs
Jul 5, 2024
Merged

Website: API documentation page#4040
swharden merged 11 commits intomainfrom
3822-api-docs

Conversation

@swharden
Copy link
Member

@swharden swharden commented Jul 3, 2024

This PR tracks progress toward pairing reflection with XML parsing to generate a minimal HTML page with basic API information (types, parameters, etc.) with XML code comments.

Lots of the automatic documentation generators are overwhelmingly complex, and I'm seeking something with minimal file size and customizable to facilitate searching on the website like the cookbook recipes are.

Resolves #3822

image

@swharden swharden added the WIP / DO NOT MERGE Note to Scott not to merge this until the original contributor indicates it's ready label Jul 3, 2024
@swharden swharden changed the title Documentation: API documentation page Website: API documentation page Jul 3, 2024
@swharden swharden removed the WIP / DO NOT MERGE Note to Scott not to merge this until the original contributor indicates it's ready label Jul 5, 2024
@swharden swharden marked this pull request as ready for review July 5, 2024 16:20
@swharden
Copy link
Member Author

swharden commented Jul 5, 2024

@swharden swharden merged commit b762d69 into main Jul 5, 2024
@swharden swharden deleted the 3822-api-docs branch July 5, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Website: add API docs for select classes

1 participant