Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Most documentation isn't viewable via dub run --build=ddox #234

Closed
grogancolin opened this issue Aug 17, 2016 · 2 comments
Closed

Most documentation isn't viewable via dub run --build=ddox #234

grogancolin opened this issue Aug 17, 2016 · 2 comments
Milestone

Comments

@grogancolin
Copy link
Contributor

Most source files don't have a ddoc comment (/// or /+ or /**) at the top of the file, this causes the info not to show up in ddox.

A simple fix would be to add /// at the start of each file :)

@Jebbs
Copy link
Owner

Jebbs commented Sep 17, 2018

I opened a pull request that allows documentation to be built with ddox, tested with dub build -b ddox.

Note that the documentation was designed to be built with the build tool included with DSFML, and I don't really know how to leverage dub to use it or to pass the ddoc macros the build tool uses when generating documentation. The documentation built with ddox won't be fully complete because of this, since the macros do a few things to help make nice documentation.

@Jebbs
Copy link
Owner

Jebbs commented Sep 17, 2018

I opened up #294 to hopefully complete documentation when using ddox, but that is something that I'll have to get to later.

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

No branches or pull requests

2 participants