Databases
StackOverflow2013
Postsdbo
POHow to document a property declared in a different file using Doxygen?
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POHow to document a property declared in a different file using Doxygen?
    primarykey
    data
    text
    <p>I use <a href="http://rentzsch.github.com/mogenerator/" rel="nofollow">mogenerator</a> to generate <a href="http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CoreData/cdProgrammingGuide.html" rel="nofollow">Core Data</a> classes. Mogenerator produces machine classes and human classes. A developer is not supposed to modify machine generated classes, since these are generated each time mogenerator is called. Human classes can, however, be modified as the developer pleases.</p> <p>Machine classes contain the declaration of every property of the Core Data entity. In Doxygen, how does one document a property defined in file A from file B?</p> <p><strong>EDIT: Added example to illustrate the question</strong></p> <p><em>Example:</em></p> <p>Ultimately, the goal here to have something similar to the example below.</p> <p><strong>FileA.h (can not be modified)</strong></p> <pre><code>@interface FileA : NSObject { NSString* myProperty; } @end </code></pre> <p><strong>FileB.h</strong></p> <pre><code>#include "FileA.h" @interface FileB : FileA { /** * @property myProperty * * This is the documentation of "myProperty" * defined in FileA but documented in FileB */ } @end </code></pre> <p><strong>Tried (documentation block inside the @interface FileB @end bock):</strong> </p> <p><em>@property myProperty</em> - Doxygen does not associated the documentation to the property.</p> <p><em>\property myProperty</em> - Doxygen does not associated the documentation to the property.</p> <p><em>@property FileA::myProperty</em> - Doxygen does not associated the documentation to the property and generates; warning: no uniquely matching class member found for FileB::myProperty</p> <p><em>\property FileA::myProperty</em> - Idem</p> <p><strong>Solution</strong></p> <p><strong>FileB.h</strong></p> <pre><code>#include "FileA.h" /** * @property FileA::myProperty * * This is the documentation of "myProperty" * defined in FileA but documented in FileB * * Documentation block MUST BE outside FileB class * */ @interface FileB : FileA { } @end </code></pre>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USDavid Andreoletti
    1. USDavid Andreoletti
    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
    1. VO
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. This table or related slice is empty.
      1. VTApproveEditSuggestion
    2. VO
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. USDavid Andreoletti
      1. VTFavorite
    1. COWhy don't you try `\property FileA::myProperty` and let us know what happens?
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. USChris
    2. COI was away from my project.
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. USDavid Andreoletti
    3. COYour use of `@interface FileB : FileA` doesn't match the documentation for the [`\interface`](http://www.stack.nl/~dimitri/doxygen/commands.html#cmdinterface) command. Also, you state in your solution that "Documentation block MUST BE outside FileB class". This shouldn't be the case - this suggests something else isn't working as expected.
      singulars
      1. POHow to document a property declared in a different file using Doxygen?
      1. USChris
 

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