SassDoc / sassdoc

Release the docs!
http://sassdoc.com
MIT License
1.41k stars 56 forks source link

Document which SASS items can be documented #526

Closed dharkness closed 6 years ago

dharkness commented 6 years ago

I've added file-level comments to a few files containing CSS rules, but they don't appear in the docs. I documented a mixin which did appear. So, what items will show up in the generated documentation once they are documented? Please list them on the Annotations page or somewhere more appropriate.

pascalduez commented 6 years ago

Hi,

each item need at least one comment/title above it to be registered. File level comments are just a way to apply annotations to several items at once.

dharkness commented 6 years ago

I was unclear, sorry. Which of these items (once documented) will appear in the docs?

Edit: Oops, I used // for the selector comment! It looks like everything except files is listed as an item in the final documentation. I don't see a need to list separate files so I've closed this issue.

However, it wouldn't hurt to specify each type of SASS construct that will appear in the sidebar once its documented.