SwiftDocOrg / swift-doc

A documentation generator for Swift projects
https://swiftdoc.org
MIT License
1.68k stars 99 forks source link

Feature request: Declarations with a documentation comment containing `:nodoc:` are excluded from the documentation. #305

Open spnkr opened 3 years ago

spnkr commented 3 years ago

would be great to add this to swift-doc.

jazzy hides declarations commented with :nodoc: like this

def self.should_document?(doc)
      return false if doc['key.doc.comment'].to_s.include?(':nodoc:')