angularJS 함수에 대한 Doxygen 설명

Question

내 프로젝트에 angularJS 및 doxygen을 사용하고 있습니다. 내 각 컨트롤러에서

, I는 다음과 같이 정의 된 일부 기능을했습니다 :

function MyCtrl($scope) { 
    /** 
     * @param page String Page name 
     * @ingroup API 
     * @author Sylvain 
     */ 
    $scope.prev = function(page) { 
     ... 
    } 

    ... other functions 
} 

내가 그 doxygen이 함수 선언으로이 코드를 이해하고 싶습니다.

나는 @fn 명령을 사용해 보았지만 새로운 기능 블록을 만들지 않고 MyCtrl 문서의 모든 각도 함수 주석을 연결했다.

아이디어가 있으십니까?

감사합니다.

Answer 1

아마 $ scope 인수가 Doxygen을 혼란스럽게합니다. 이름을 "범위"로 변경하고 @param 주석에서 "페이지"를 "범위"로 바꾸면 Doxygen이 올바르게 작동합니다. 적절한 내용의 함수 선언 문서 섹션을 생성합니다.

Doxygen은 JavaScript를 지원하지 않지만 $ 기호 덕분에 JavaScript가 PHP처럼 보이지 않으면 작동합니다.

이 링크가 도움이 될 수도 아마도, http://blog.coherent-labs.com/2012/10/documenting-javascript-with-doxygen.html