Docs: Add initial doxygen setup #2408
Conversation
|
Whoa is that generating docs from parsing the C++ source? My primary concern here is that having the internals documented implies a stability contract that we don't offer. |
|
This is hella cool though - https://nschonni.github.io/libsass/html/class_sass_1_1_a_s_t___node.html |
Right now it doesn't even get pushed into the repo since it's gitignored. I just figured it was a good start to get it in place. Then the javadoc style blocks can be added to start indicating the stablity of parts before maybe adding it to a CI build publish |
|
Aside from the C API it's all unstable, maybe indefinitely. If we could
restrict the parsing to just those file this could be nifty though.
…On 2 Jun. 2017 4:09 pm, "Nick Schonning" ***@***.***> wrote:
My primary concern here is that having the internals documented implies a
stability contract that we don't offer.
Right now it doesn't even get pushed into the repo since it's gitignored.
I just figured it was a good start to get it in place. Then the javadoc
style blocks can be added to start indicating the stablity of parts before
maybe adding it to a CI build publish
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#2408 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAjZWOJNlGpEA31aRKMvH_WjYMP7Hbfzks5r_6c3gaJpZM4Nt2AE>
.
|
| # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, | ||
| # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. | ||
|
|
||
| FILE_PATTERNS = |
There was a problem hiding this comment.
@xzyfer I think by changing this to the sass.h, and mabye the docs, it would only expose those parts
Took the idea/template from the N-API project.
Currently the generated docs are excluded from the project, but I pushed up and example here http://nschonni.github.io/libsass/html/ afer turning on the
docsfolder in the Settings