GTK-Doc

GTK-박사는 C 코드를 문서화하는 데 사용됩니다. 이것은 전형적 GTK +와 GNOME 라이브러리로서 라이브러리의 공개 API를 문서화하는데 사용되지만 또한 응용 프로그램 코드를 기록 할 수있다.
GTK-박사는 원래 범용 문서 도구로 구성되지 않았 음을 참고, 그래서 설치 및 사용에 불편 비트가 될 수 있습니다. 더 세련 범용 문서 도구를 들어, 당신은 Doxygen을 (http://www.doxygen.org/)을보고 할 수 있습니다. 그러나 GTK-박사는 GTK + 위젯과 다른 도구가 없을 수 있습니다 G 객체 클래스의 신호와 속성을 문서화하는 특별한 코드가 있습니다.
GTK-박사는 문서는 2 가지 방법으로 기록 될 수 있습니다 :
) 특별히 형식의 주석 소스 코드 내부에 내장.
또는
b)는 모든 헤더 파일을 검색하고 선언을 분석 한 후 '템플릿'파일 GTK - 문서 출력에 추가되었습니다.
이 소스 코드의 의견과 템플릿 파일 GTK-박사 후 HTML로 변환은 DocBook XML (또는 SGML) 문서를 생성에서. 생성 된 HTML 문서는 일반 웹 브라우저 또는 특별한 Devhelp API의 브라우저를 사용하여 탐색 할 수 있습니다 (http://developer.imendio.com/wiki/Devhelp).

What이 릴리스의 새로운 기능입니다 참조

GTK-DOC가 인하 (제목과 목록)의 하위 집합을 지원합니다 - 참조
http://git.gnome.org/browse/gtk-doc/tree/tests/gobject/src/gobject.c
이전 devhelp를 생성하지 않습니다 GTK-DOC는 더 이상 파일. 이 문서를 줄인다
= 0.11는 (2005 년에 발표 된) 생성 시간 및 devhelp된다 작동합니다.
밖으로의 소스 디렉토리 빌드에 대한 변경하여 프로젝트에 대한 파손의 원인
DOC_SOURCE_DIR 상대 경로 (builddir합니다). 그것은 사용하는 것이 좋습니다
DOC_SOURCE_DIR = $ (top_srcdir) / / XXX SRC.
변경
590927은 : 단계를 DOC는 빌드에 대한 지원은 AM_SILENT_RULES
617121 : / * & LT; 전용된다 * / 열거 형의 선언이 여전히 표시됩니다
627758 : 기호를 무시하는 방법
639145 : 제목에 대한 약식 구문
644291 : 할당에 열거 파서 나누기 ')'
646870은 : EXTRA_DIST 더 이상 HTML_IMAGES 없습니다
648289 : gtkdoc-mkdb가 컴파일되지 않습니다.
648331 : 지속적으로 '하이라이트'에 대한 호환 옵션을 지정합니다.
649269 : gtkdoc-scanobj는 자신의 CFLAGS / LDFLAGS의 일부를 설정해야합니다
650407 : 건물 문서를 distchecking은 € 오노 선언 founda €의 수천을 생성하는 동안 ?? 경고, 실패합니다.
652746 : 깨진 일반 박스 구조체의 문서
652764 : 조금 config (설정) 업데이트 autotools를
655711 : 패키지로 depscan 출력을 요약
656453 : 성능 향상 (PATCH)
656658 : GTK-doc.make : 별도의 디렉토리에 구축 할 때 문서를 설치하지 않는 대상을 설치
656773은 : GTK-DOC는 '숯불 *의 CONST'로 선언 된 심볼을 찾기 위해 실패
656946 : '통근 짧은 INT'을 처리 할 GTK-DOC 없습니다
657377 :! SRCDIR = builddir는 tmpl의 내용을 삭제 구축
참여자
Bakaoukas 니콜
클로드 Paroz
다니엘 Mustieles
데이비드 네 카스
데이비드 NEA ??로
하비에르 JardA³n
호르헤 곤잘레스
마리오 BlA¤ttermann
마티아스 Clasen
MichaA, GA³rny
숀 McCance
스테판 사우어 (코스트)
윌 톰슨
Yaakov Selkowitz

요구 사항 :

펄 V5
libxslt를 & libxml2를 2.3.6
의 DocBook XSL 스타일 시트
의 DocBook XML의 DTD
의 DocBook SGML의 DTD
옥 V1.1 또는 있으며, OpenJade 1.3.1
의 DocBook DSSSL 스타일 시트