Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p>Its unclear (to me) whether you want <code>FileA</code> to be documented, but you can't insert the documentation into <code>FileA.h</code>, or if you want <code>FileA</code> to be undocumented, but have its members appear in the (documented) derived class <code>FileB</code>.</p> <p>If its the former, you can provide documentation for class <code>FileA</code> in <code>FileB.h</code>, this would appear as something like:</p> <pre><code>/** * @class FileA * Documentation for FileA * * @var FileA::myProperty * Documentation for myProperty */ /** * Documentation for FileB */ @interface FileB : FileA { } @end </code></pre> <p>This will cause classes <code>FileA</code> and <code>FileB</code> to appear in the generated docs, with <code>myProperty</code> documented as a member of <code>FileA</code>.</p> <p>If its the latter, you could declare <code>myProperty</code> as a member of <code>FileB</code>, but use a preprocessor guard to only include the declaration when generating your documentation, something like:</p> <pre><code>/** * document FileB */ @interface FileB : FileA { #ifdef DOXYGEN /** * This is the documentation of "myProperty" * defined in FileA but documented in FileB */ NSString* myProperty; #endif } @end </code></pre> <p>This will cause <code>FileB</code> to be documented as if <code>myProperty</code> was one of its members. Be aware that if the declaration of <code>myProperty</code> changes in <code>FileA</code>, you'll have to manually update <code>FileB</code>'s declaration to reflect those changes.</p>
    singulars
    1. This table or related slice is empty.
    1. POHow to document a property declared in a different file using Doxygen?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USDRH
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. POHow to document a property declared in a different file using Doxygen?
      singulars
      1. PTQuestion
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTAcceptedByOriginator
    1. COIdeal solution would be the second option: Have FileA undocumented BUT have its members/accessors appear in the (documented) derived class FileB. This is better from a developer's point of view who reads the documentation about FileB. Ideally, FileA does not exist in the developer's mind (as well as in the documentation)
      singulars
      1. PO
      1. USDavid Andreoletti
    2. COI finally went for the former proposed solution. Thanks.
      singulars
      1. PO
      1. USDavid Andreoletti
 

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