UIApplication에 대한 설명서에는 알림 섹션이 포함되어 있습니다. 모든 관련 NSNotification이 나열되어 있습니다. Xcode에서 사용할 수있는 헤더 파일에는 해당 주석이 없습니다. HeaderDoc User Guide은 @group 태그를 사용하여 항목을 그룹화하고 UIApplication 문서와 유사한 결과를 설명하는 방법을 보여줍니다
XCode 5는 이제 헤더 파일에서 직접 헤더 주석을 읽을 수 있으므로 일관된 방식으로 기능을 문서화하는 것이 점점 더 흥미로워지고 있습니다. 따라서 나는 헤더 도큐멘트 주석을 Objective C 헤더 파일에 자동으로 삽입 할 수 있지만 찾을 수없는 도구를 찾으려고합니까? /*!
<desc method.>
@param parmA
내 인터페이스를 문서화하고 싶습니다. 인터페이스는 C++로 작성되었으며 .hpp 파일에 있습니다. 그러나 headerdoc2html은 .hpp 파일에 대해 알지 못합니다. 그것은 .h 파일을 기대합니다.
$ headerdoc2html include/*.hpp
HTML output mode.
File include/serializer.hpp is no
iOS 앱용 재사용 가능한 API 구성 요소를 만들고 있습니다. 필자는 API를 완료했으며 이후 사용자를 위해 headerdoc을 사용하여 문서화했습니다. 이제 헤더 파일을위한 HTML 페이지를 만들고 싶습니다. 그래서 난 내 프로젝트 디렉터리 headerdoc2html -o ~/Desktop/My_Project_Documentation APIFolder/