Как да документирам свойство, декларирано в различен файл с помощта на Doxygen?

Не е ясно (за мен) дали искате FileA да бъде документиран, но не можете да вмъкнете документацията в FileA.h, или ако искате FileA да не е документиран, но неговите членове да се показват в (документирания) производен клас FileB.

Ако е първото, можете да предоставите документация за клас FileA в FileB.h, това ще изглежда като нещо като:

/**
 * @class FileA
 * Documentation for FileA
 *
 * @var FileA::myProperty
 * Documentation for myProperty
 */

/**
 * Documentation for FileB
 */
@interface FileB : FileA
{
}

@end

Това ще доведе до показване на класове FileA и FileB в генерираните документи, като myProperty е документиран като член на FileA.

Ако е последното, можете да декларирате myProperty като член на FileB, но да използвате защита на предпроцесора, за да включите декларацията само при генериране на вашата документация, нещо като:

/**
 * document FileB
 */
@interface FileB : FileA
{
#ifdef DOXYGEN
    /**
     * This is the documentation of "myProperty" 
     * defined in FileA but documented in FileB
     */
    NSString* myProperty;
#endif
}

@end

Това ще накара FileB да бъде документиран, сякаш myProperty е един от неговите членове. Имайте предвид, че ако декларацията на myProperty се промени в FileA, ще трябва ръчно да актуализирате декларацията на FileB, за да отразите тези промени.

Можете да препращате към achor (напр. файлове, пространства от имена, класове, функции, променливи, enum и т.н.), като използвате ref команда, използваща например

\ref variable_name

Ако променливата, която искате да документирате, не е в локалното пространство от имена или обхват, можете да добавите префикс към името на променливата с namespace::, където namespace е обхватът или класът, където е дефинирана променливата, към която се отнасяте. Например, разгледайте следните два файла (модифицирани от примери в ръководството на Doxygen):

Файл 1:

///  A test class.
/**
  A more elaborate class description.
*/
class Test
{
  public:

  /// An enum.
  /** More detailed enum description. */
  enum TEnum {
               TVal1, ///< Enum value TVal1.
               TVal2, ///< Enum value TVal2.
               TVal3  ///< Enum value TVal3.
             }
      /// Enum pointer.
      /** Details. */
      *enumPtr,
      /// Enum variable.
      /** Details. */
      enumVar;

  /// A constructor.
  /**
    A more elaborate description of the constructor.
  */
  Test();
};

Файл 2:

//  Another test class.
/**
  This class depends on the variable \ref Test::TEnum, defined in another file.
  It doesn't, actually, but I've said it does.
*/
class AnotherTest
{
  public:

  /// A constructor
  AnotherTest();

};

Тук TEnum е дефиниран в класа Test в първия файл. Така че във втория файл поставяме пред името на променливата класа, в който е дефинирана, т.е. Test::TEnum.

Вижте приетия отговор на въпроса Референтни статични const променливи, декларирани в пространство от имена за повече информация относно префикса на глобалното пространство от имена ::.