2014-06-12 2 views
0

소스 파일 (.c)에있는 문서화되지 않은 함수/메서드로 인한 피해를 생성하지 못하게하는 방법입니다. 나는 헤더 파일에 모든 주석을 가지고 있으며 그것을 복제하고 싶지 않다. 문서화 소스 코드를 끄고 싶지는 않지만이 파일의 메소드에 대한 주석만을 끄십시오.Doxygen/소스 파일 설명

미리 제안 해 주셔서 감사합니다.

나는 당신의 Doxyfile에서 설정 옵션을 변경하여 취할 수있는 두 가지 방법 모두 생각할 수

답변

0

: 당신은 (true로 기본값) False로 WARN_IF_UNDOCUMENTED을 설정하면

  1. , Doxygen을 어떤 기능에 대해 불평하지 않을 것이다 또는 문서화되지 않은 방법. (경고는 당신이 모든 방법과 기능을 문서화했는지 확인하는 유용한 방법이 될 수 있기 때문에 그렇게하고 싶지는 않을 것입니다.)
  2. 접미어를 기준으로 파일을 포함하거나 제외하도록 구성을 설정하십시오. 예를 들어 문제의 원인이되는 메서드와 함수에 모두 .c 접미사가있는 경우 EXCLUDE_PATTERNS에서 *.c으로 설정하여 모든 .c 파일을 무시할 수 있습니다.

Doxygen configuration documentation은 꽤 포괄적이며 거기에 더 적합한 다른 방법이 있습니다.

+0

이 솔루션을 고려하고 있었지만 C 파일에서 저자, 그룹 (모듈) 등에 대한 의견이 있습니다. – Radek

+0

그럼 WARN_IF_UNDOCUMENTED = False가 될까요? 당신은 또한 큰 망치의 무언가이지만 [WARNINGS = NO] (http://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_warnings)를 사용하여 도매 경고를 볼 수 있습니다. – morric