2014-02-15 3 views
0

UIApplication에 대한 설명서에는 알림 섹션이 포함되어 있습니다. 모든 관련 NSNotification이 나열되어 있습니다.headerdoc을 사용하여 NSNotifications를 올바르게 문서화하는 방법은 무엇입니까?

Xcode에서 사용할 수있는 헤더 파일에는 해당 주석이 없습니다.

HeaderDoc User Guide@group 태그를 사용하여 항목을 그룹화하고 UIApplication 문서와 유사한 결과를 설명하는 방법을 보여줍니다.

그룹화 태그를 사용하면 함수, 메소드 및 변수를 모음으로 구성 할 수 있습니다. HTML 출력 모드에서 목차 (왼쪽 열)는 이러한 그룹으로 구성됩니다. 또한 본문 내용 (오른쪽)에는 각 그룹에 대한 문서가 들어 있습니다. 이 문서 블록에는 그룹의 이름, 토론 및 해당 그룹에 포함 된 함수, 데이터 유형 또는 변수 목록이 요약과 함께 들어 있습니다. 나는 @group 태그를 사용하려고하면

그러나, 나는 경고 Unknown command tag name를 수신하고 @group 태그는 엑스 코드를 인식하지 못할 것 같다하고, 어두운 녹색으로 강조 표시되지 않습니다.

답변

0

알림 자체는 아직 문서화되지 않았기 때문에 경고는 일시적입니다. 알림을 문서화하자마자 경고가 사라졌습니다.

그러나 Xcode는 여전히 다른 headerdoc 태그처럼 짙은 녹색으로 group 태그를 표시하지 않습니다.

관련 문제