Skip to content
New issue

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

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

Already on GitHub? # to your account

Microscopic issue in a comment causes tons of warnings when using document builder #47

Closed
cdcrchrisparker opened this issue Jan 29, 2024 · 9 comments
Labels
documentation Improvements or additions to documentation

Comments

@cdcrchrisparker
Copy link

cdcrchrisparker commented Jan 29, 2024

This is in the comments only, hence does not affect code at all. There is a missing right paren in the comments for source/raylib/rlgl.d - this missing paren causes dozens of warnings whenever one uses the document generator. E.g.

dub build --build=docs

The solution? Line 78 of source/raylib/rlgl.d needs a trailing closing paren.

#define RL_DEFAULT_SHADER_UNIFORM_NAME_NORMAL "matNormal" // normal matrix (transpose(inverse(matModelView)))

@cdcrchrisparker cdcrchrisparker changed the title Microscopic issue in a comment causes tons of warnings when document builder Microscopic issue in a comment causes tons of warnings when using document builder Jan 29, 2024
@schveiguy schveiguy added the documentation Improvements or additions to documentation label Jan 29, 2024
@schveiguy
Copy link
Owner

Please file in raylib upstream as well (if not already fixed) -- rlgl is mechanically translated using dstep.

@cdcrchrisparker
Copy link
Author

Oh - okay. Didn't know that, I'll do so now. :)

@schveiguy
Copy link
Owner

Also, the doc builder is going to suck -- none of the docs will be used since they are only double-slash. I need to do some kind of mechanical translation of the raylib comments to ddoc comments.

See also #13

@schveiguy
Copy link
Owner

Please let me know if that works -- 9906279

I may not do a release unless you really need it, as this affects nothing normally used.

@cdcrchrisparker
Copy link
Author

I'm actually only interested in my own documentation, and was mildly surprised that the doc builder builds library stuff as well.

Having said that, I might some spare cycles helping out with DDOC at some point in the near future.

@schveiguy
Copy link
Owner

OK, I'll do a release so it doesn't affect your project, sorry.

@cdcrchrisparker
Copy link
Author

I edited my own version by hand. Not to worry about the release, it's not an issue at all. I just thought you'd like to know since it looks horrible when generating docs, and has such a simple resolution.

@schveiguy
Copy link
Owner

Well, I already did it ;) Not a huge deal.

@schveiguy
Copy link
Owner

Having said that, I might some spare cycles helping out with DDOC at some point in the near future.

That would be really great!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants