Menu

#102 Doc of protected items in sealed classes

closed
5
2003-12-01
2003-11-28
No

When generating public documentation for my class
framework I would like that not all protected methods
and fields are included in the documentation. Currently I
have only the choice of setting DocumentProtected to
true or false.

For a documentation for external consumtion, only those
protected items that are actually accessible from
external code should be documented. However, not all
protected items are accessible.

Protected items are only accessible when the belong to
a class that an external class can derive from. This
means that a protected item should only be included in
the documentation when it belongs to a public and non-
sealed class.

Thanks for considering this request.

Discussion

  • Andreas Selle

    Andreas Selle - 2003-12-01

    Logged In: YES
    user_id=919532

    OK, now that I joined the ndoc developer community I will add
    this feature myself. This is the solution, I think of: I add a
    flag "DocumentSealedProtected" with the default value False.
    If this is True, then protected members of a sealed class will
    be documented exactly as before. If this is False, then
    protected members of a sealed class will not be documented.

     
  • Andreas Selle

    Andreas Selle - 2003-12-01
    • assigned_to: nobody --> andiselle
     
  • Andreas Selle

    Andreas Selle - 2003-12-01
    • status: open --> closed
     
  • Andreas Selle

    Andreas Selle - 2003-12-01

    Logged In: YES
    user_id=919532

    Done in Core.BaseDocumenterConfig.cs 1.34 and
    Core.BaseDocumenter.cs 1.93.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.