3

私はコードを持っています(C++で、しかし他の言語の問題の解決策はおそらく似ています):

namespace details {
  struct C {
    /// Documentation for common method.
    void c();
  };
};

/// Documentation for class A
struct A: public details:C {
  /// Documentation for method a
  void a();
};

/// Documentation for class B    
struct B: public details:C {
  /// Documentation for method b
  void b();
};

そして、ドキュメントでクラス C (および詳細名前空間全体) を非表示にしたいと考えています (A と B の実装を短くするためだけに存在します)。しかし、ソースのように、c メンバー (および C から継承された他のすべてのメンバー) を文書化して、ドキュメントに A と B を含める必要があります。

/// Documentation for class A
struct A {
  /// Documentation for method a
  void a();

  /// Documentation for common method.
  void c();
};

/// Documentation for class B    
struct B {
  /// Documentation for method b
  void b();

  /// Documentation for common method.
  void c();
};

これを適切に行う方法は?

4

0 に答える 0