2010-03-08 4 views
4

출력의 일부로 파일의 SVN에서 로그를 포함하도록 Doxygen을 구성하는 방법이 있습니까? 기본적으로 우리는 커밋 할 때 SVN에 꽤 엄격한 로그 메시지를 입력하고, 그 메시지가 Doxygen 출력 내부에 섹션을 갖게하고 싶습니다.Doxygen에 SVN 로그 메시지 포함

답변

2

나는이 간단한 또는 쉬운 해결책을 모르지만 당신이 함께 뭔가를 빠르게 해킹 할 수 있다고 생각합니다.

  • 우선은 svn2cl tool에서 svn2html.xsl 스타일 시트를 사용하여 SVN 로그에서 HTML 파일 를 생성 할 수 있습니다. 을 좋아하지 않는 경우 실제로는 과 같은 것을 쓰는 것이 어렵지 않습니다. read in this blog post처럼 작성할 수 있습니다.
  • 둘째로 Doxygen 출력을 수정하여 1 단계에서 생성 된 html 파일에 대한 링크를 포함 할 수 있습니다. 나는 그것에 대해 많이 알지 못하지만 어쩌면 doxygen manual page about customization이 좋은 시작일 것입니다.
  • 셋째는 단계 하나, 둘 가능성이 하게 사용하거나 쉘 스크립트 또는 배치 파일을 자동화하는 것이 당신의 문서에 대한 작은 빌드 파일을 작성할 수 있습니다.

매우 우아하지만 시작은 아닙니다.

+0

+1 나는 유사한 선을 생각하고 있었다고 생각합니다. 변경 사항도 일괄 처리하려고합니다. – amelvin

+0

기본적으로 정확하게 대답을 사용했지만, 출력 된 doxygen을 svn에 연결하려면 약간의 수작업이 필요했습니다 (이 작업을 수행하는 자동화 된 방법이없는 것처럼 보입니다). doxygen에 주석 안에 링크를 삽입하여 각각의 개별 파일에 생성 된 로그 파일에 대한 링크가 포함될 수 있습니다 (비트 오류가 발생하기 쉽고 하위 디렉토리에 중복 된 이름을 가진 파일이 있으면 복잡 할 수 있습니다). svn 로그를 생성하기 위해 모든 파일을 반복 한 다음 doxygen을 실행하는 것은 모두 간단한 쉘 스크립트를 통해 이루어진다. – Medran

+0

사용자 정의에 대한 페이지를 살펴보면 doxygen의 xml 출력 옵션을 사용하여 svn 출력과 doxygen 출력 사이의 링크를 자동으로 작성하는 프로그램을 작성하는 것이 가능할 것이라는 확신이 들었지만, 많은 일. – Medran

2

빌드 서버 (CruiseControl/Bamboo/TeamCity 등) 사용 방법은 어떻습니까? 빌드 서버가 svn에서 변경 사항을 모니터링하고 빌드 스크립트 (예 : ant)가 빌드의 일부로 Doxygen을 호출합니다. Java 및 C# 결합 빌드 작업에서이 배열을 사용합니다. 빌드 스크립트는 적절한 옵션을 사용하여 "svn log"를 사용하여 최신 커밋 메시지를 선택할 수 있습니다.

0

나는 생각을 좋아하지만 확실히 한 번에 SVN 만 커밋했거나 doxygen 출력이 관련없는 의견으로 흩어져있는 경우에만 작동 할 것입니다.

SVN 커밋의 일괄 업데이트를 사용하여 수행 할 수 있다고 생각합니다.

커밋 된 파일과 SVN 로그 파일을 열어 변경된 설명을 표시하는 SVN 커밋을 추출 할 수 있습니다. 따라서 야간에 로그 파일을 돌리고 사전 또는 HashTable을 작성하여 야간에 변경된 파일 및 주석을 작성하는 Windows 서비스 또는 cron 작업을 작성할 수 있습니다. 그와 함께 자리에 설명 섹션의 끝 부분에 대한 크론/승리의 공개 서비스를 언급 한 각 파일, 검색이 :

* @section DESCRIPTION 
* 
* 
* 
**/ 

을이 섹션에서 주석을 배치합니다.

+0

글쎄, 나는 그것의 가능성이 산산조각이 될 수 있지만 우리는 시도하고 작업 당 커밋, 그래서 전체 커밋에 적용 할 것이라고 1 또는 2 줄 주석. – Medran

관련 문제