Doxygen 주석을 편집하기위한“Wiki”가 있습니까? [닫은

Question

나는 상당히 큰 오픈 소스 RTS 게임 엔진을 연구하고 있습니다 (봄). 최근에 LUA가 호출 할 수있는 새로운 C ++ 기능을 추가했으며 가장 잘 문서화하는 방법이 궁금해하며 동시에 사람들이 문서를 작성/업데이트하도록 자극합니다. 많이 기존 LUA 콜 아웃.

그래서 나는 C ++ 함수 근처에서 Doxygen 댓글로 처음 문서를 작성할 수 있다면 좋을 것이라고 생각했습니다. 기능 본문이 기능의 기능을 정확하게 정의하기 때문에 쉽습니다. 그러나 일반적으로 GIT (우리가 사용하는 VC) 또는 C ++에 대한 이해가 거의없는 엔진을 사용하여 게임 개발자가 문서를 개선하고 싶습니다.

따라서 C ++ 파일에서 APIDOC를 자동으로 생성 할 수있는 방법이 있지만 Wiki와 같은 웹 인터페이스를 통해 훨씬 더 많은 잠재 고객이 주석을 업데이트하고 예제를 추가 할 수 있도록하는 것이 이상적입니다.

따라서 Doxygen 스타일 형식, 위키와 같은 편집 (소스 파일의 다른 부분을 편집하지 않고) 및 git을 통합하는 웹 도구가 있습니까? (웹 인터페이스를 통해 특별 지점으로 변경된 주석을 커밋하려면)

그런 다음 개발자는 매번이 지점을 병합 한 다음 마스터 브랜치에 개선 사항을 추가 할 수 있으며 동시에 개발자의 문서 개선은 마스터 브랜치를이 스페셜로 병합 하여이 웹 도구를 사용하게됩니다. 나뭇가지.

나는 아직 아무것도 찾지 못했고,이 특정한 것이 아직 존재하는 것을 의심하므로 어떤 제안도 환영합니다!

Answer 1

이것은 참으로 매우 멋진 아이디어이며, 몇 년 전에 나는 그런 것을 매우 강하게 필요로했습니다. 불행히도, 적어도 그 당시에는 그런 것을 찾을 수 없었습니다. SourceForge와 FreshMeat에서 빠른 검색을해도 오늘날 관련된 것은 없습니다.

그러나 나는 사용자가 기부 한 문서에 대한 위키 프론트 엔드가 매우 유용 할 것이라는 데 동의합니다. 나는 최근 LUA 커뮤니티 내에서 이와 같은 것이 최근에 논의되고 있다는 사실을 알고 있습니다 (참조 이것).

따라서 기본 작업 초안/프로토 타입을 제시하기 위해 요구 사항을 결정할 수 있습니까?

바라건대,이를 통해 최소한의 기능 세트가있는 그러한 프로젝트를 시작한 다음 다른 사용자가 기여할 수 있도록 오픈 소스 프로젝트 (예 : SourceForge)로 야생으로 간단히 해제 할 수 있기를 바랍니다.

이상적으로는 통합 패치를 사용하여 그러한 방식으로 기여한 변경 사항을 적용 할 수 있습니다. 또한, 텍스트의 임의의 수정을 허용하는 대신 주석을 추가/편집하는 것만으로 만 수정을 제한하는 것이 합리적 일 것입니다. 간단한 동정인을 사용하여 구현 될 수 있습니다.

아마도 MediaWiki와 같은 기존 (기존) Wiki 소프트웨어를 수정하여 이와 같은 것을 구현할 수 있습니다. 또는 바람직하게는 이미 GIT를 스토리지 목적으로 백엔드로 사용하고있는 것입니다. 그런 다음 주로 Doxygen 스타일의 의견을 제공하고 그 위에 간단한 인터페이스를 제공해야합니다.

Doxygen 자체는 이미 HTML 문서를 생성하는 데 지원을 제공하고 있으므로 이러한 관점에서 실제로 Doxygen을 확장 할 수있는 방법이 흥미로울 수 있으므로 쉽게 스크립트 된 백엔드와 잘 통합되어있어 쉽게 볼 수 있습니다. 임베디드 소스 코드 문서의 사용자 정의.

이것은 아마도 Doxygen (예 : Python, PHP 또는 Perl)과 함께 독립형 스크립트를 제공 한 다음 자동으로 생성 된 HTML 문서에 양식을 임베드하여 문서화 수정/증강이 브라우저를 통해 해당 스크립트로 보낼 수 있도록 주로 요약 될 것입니다. , 이는 수정을 해당 분기에 다시 작성합니다.

장기적으로, 이러한 스크립트가 다른 유형의 백엔드 (CVS, SVN 또는 GIT)를 지원하거나 적어도 일반적으로 충분히 구현되므로 쉽게 확장 할 수 있도록 시원합니다.

따라서 우리가 좋은 디자인을 제시 할 수 있다면, 그러한 수정이 일반적으로 Doxygen 자체에 대한 기여로 받아 들여질 수 있으며, 이는 모든 것들에 훨씬 더 많은 노출과 운동량을 줄 수 있습니다.

아이디어가 실제 프로젝트로 직접 구체화되지 않더라도 다른 사용자가 실제로 아이디어를 좋아하는지 확인하는 것이 흥미로울 것입니다.https://github.com/doxygen/doxygen/issues/new).

편집 : 체크 아웃 할 수도 있습니다 이것 제목의 기사 "문서, git 및 mediawiki".