Databases
StackOverflow2013
Postsdbo
POHow to configure Doxygen to document Objective-C categories properly
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow to configure Doxygen to document Objective-C categories properly
    primarykey
    data
    text
    <p>Doxygen appears to have idiosyncratic handling of Objective-C categories and I would like to know if others have been able to work around it successfully. I would like doxygen to document all categories on a class as separate entities, irrespective of whether the base class is documented or not.</p> <p>If I add doxygen markup to a category on an <em>undocumented</em> base class - say NSString, then doxygen lists the category and its methods in the class list as a separate entity. </p> <pre><code>/** * @category NSString(Foo) * @brief A sample category on NSString */ @interface NSString(Foo) @end </code></pre> <p>Results in a documented entity NSString(Foo) in the class list.</p> <p>But, the following example <em>does not</em>:</p> <pre><code>/** * @category CCFMyCustomClass(Foo) * @brief A category on a documented base class */ @interface CCFMyCustomClass(Foo) @end </code></pre> <p>Instead, in the latter case, all of the methods on CCFMyCustomClass(Foo) are included in the documentation for CCFMyCustomClass - the base class.</p> <p>The following, though often cited, don't seem to help with this problem:</p> <ul> <li><p><a href="https://stackoverflow.com/questions/2042595/doxygen-and-objective-c-categories">Doxygen and Objective-C categories</a></p></li> <li><p><a href="http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/" rel="nofollow noreferrer">http://www.duckrowing.com/2010/03/18/documenting-objective-c-with-doxygen-part-i/</a></p></li> </ul>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USCommunity
    1. USFluffulousChimp
    plurals
    1. PL
      singulars
      1. LTLinked
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    3. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POHow to configure Doxygen to document Objective-C categories properly
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POHow to configure Doxygen to document Objective-C categories properly
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow to configure Doxygen to document Objective-C categories properly
      1. USBarry Wark
      1. VTFavorite
    1. This table or related slice is empty.
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload