diff --git a/Makefile b/Makefile index 6ae7698..f954392 100644 --- a/Makefile +++ b/Makefile @@ -31,6 +31,22 @@ dist: $(PACKAGE)-$(VERSION)/doc/gtkdoc/Makefile \ $(PACKAGE)-$(VERSION)/doc/gtkdoc/libSystem-docs.xml \ $(PACKAGE)-$(VERSION)/doc/gtkdoc/project.conf \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/Makefile \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/System.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/array.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/buffer.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/config.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/error.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/event.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/file.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/hash.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/libSystem-unused.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/object.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/parser.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/plugin.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/string.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/token.sgml \ + $(PACKAGE)-$(VERSION)/doc/gtkdoc/tmpl/project.conf \ $(PACKAGE)-$(VERSION)/include/System.h \ $(PACKAGE)-$(VERSION)/include/Makefile \ $(PACKAGE)-$(VERSION)/include/project.conf \ diff --git a/doc/Makefile b/doc/Makefile index 60a5bfd..1c86078 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -1,5 +1,5 @@ SUBDIRS = gtkdoc -TARGETS = gtkdoc/libSystem.types gtkdoc/sgml.stamp html/index.html +TARGETS = gtkdoc/libSystem.types gtkdoc/tmpl.stamp gtkdoc/sgml.stamp gtkdoc/html.stamp PREFIX = /usr/local DESTDIR = RM ?= rm -f @@ -16,19 +16,22 @@ subdirs: gtkdoc/libSystem.types: ./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/libSystem.types" -gtkdoc/sgml.stamp: gtkdoc/libSystem.types +gtkdoc/tmpl.stamp: gtkdoc/libSystem.types + ./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/tmpl.stamp" + +gtkdoc/sgml.stamp: gtkdoc/tmpl.stamp ./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/sgml.stamp" -html/index.html: gtkdoc/libSystem-docs.xml gtkdoc/sgml.stamp - ./gtkdoc.sh -P "$(PREFIX)" -- "html/index.html" +gtkdoc/html.stamp: gtkdoc/libSystem-docs.xml gtkdoc/sgml.stamp gtkdoc/tmpl.stamp + ./gtkdoc.sh -P "$(PREFIX)" -- "gtkdoc/html.stamp" clean: @for i in $(SUBDIRS); do (cd $$i && $(MAKE) clean) || exit; done - $(RM) -- $(gtkdoc/libSystem.types_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(html/index.html_OBJS) + $(RM) -- $(gtkdoc/libSystem.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) distclean: @for i in $(SUBDIRS); do (cd $$i && $(MAKE) distclean) || exit; done - $(RM) -- $(gtkdoc/libSystem.types_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(html/index.html_OBJS) + $(RM) -- $(gtkdoc/libSystem.types_OBJS) $(gtkdoc/tmpl.stamp_OBJS) $(gtkdoc/sgml.stamp_OBJS) $(gtkdoc/html.stamp_OBJS) $(RM) -- $(TARGETS) install: $(TARGETS) diff --git a/doc/gtkdoc.sh b/doc/gtkdoc.sh index 86353ba..a393000 100755 --- a/doc/gtkdoc.sh +++ b/doc/gtkdoc.sh @@ -95,15 +95,15 @@ while [ $# -gt 0 ]; do #create case "$target" in - html/index.html) - $MKDIR "html" && - (cd "html" && + gtkdoc/html.stamp) + $MKDIR "gtkdoc/html" && + (cd "gtkdoc/html" && $DEBUG $GTKDOC_MKHTML "$MODULE" \ - "../gtkdoc/$MODULE-docs.xml") && + "../$MODULE-docs.xml") && (cd "gtkdoc" && $DEBUG $GTKDOC_FIXXREF \ --module="$MODULE" \ - --module-dir="../html" \ + --module-dir="html" \ --html-dir="$DATADIR/doc/html/$MODULE") ;; gtkdoc/sgml.stamp) diff --git a/doc/gtkdoc/Makefile b/doc/gtkdoc/Makefile index be735a4..38b7ceb 100644 --- a/doc/gtkdoc/Makefile +++ b/doc/gtkdoc/Makefile @@ -1,13 +1,21 @@ +SUBDIRS = tmpl -all: +all: subdirs + +subdirs: + @for i in $(SUBDIRS); do (cd $$i && $(MAKE)) || exit; done clean: + @for i in $(SUBDIRS); do (cd $$i && $(MAKE) clean) || exit; done -distclean: clean +distclean: + @for i in $(SUBDIRS); do (cd $$i && $(MAKE) distclean) || exit; done install: + @for i in $(SUBDIRS); do (cd $$i && $(MAKE) install) || exit; done uninstall: + @for i in $(SUBDIRS); do (cd $$i && $(MAKE) uninstall) || exit; done -.PHONY: all clean distclean install uninstall +.PHONY: all subdirs clean distclean install uninstall diff --git a/doc/gtkdoc/project.conf b/doc/gtkdoc/project.conf index b934cfb..e1e293f 100644 --- a/doc/gtkdoc/project.conf +++ b/doc/gtkdoc/project.conf @@ -1 +1,2 @@ +subdirs=tmpl dist=Makefile,libSystem-docs.xml diff --git a/doc/gtkdoc/tmpl/Makefile b/doc/gtkdoc/tmpl/Makefile new file mode 100644 index 0000000..be735a4 --- /dev/null +++ b/doc/gtkdoc/tmpl/Makefile @@ -0,0 +1,13 @@ + + +all: + +clean: + +distclean: clean + +install: + +uninstall: + +.PHONY: all clean distclean install uninstall diff --git a/doc/gtkdoc/tmpl/System.sgml b/doc/gtkdoc/tmpl/System.sgml new file mode 100644 index 0000000..a088178 --- /dev/null +++ b/doc/gtkdoc/tmpl/System.sgml @@ -0,0 +1,22 @@ + +System + + + + + + + + + + + + + + + + + + + + diff --git a/doc/gtkdoc/tmpl/array.sgml b/doc/gtkdoc/tmpl/array.sgml new file mode 100644 index 0000000..16e8bb7 --- /dev/null +++ b/doc/gtkdoc/tmpl/array.sgml @@ -0,0 +1,134 @@ + +Array + + + + + + + + + + + + + + + + + + + + + + + + + +@type: +@name: + + + + + + + + + + + + + +@value: +@data: + + + + + + + +@array: +@value: +@Returns: + + + + + + + +@array: +@Returns: + + + + + + + +@array: + + + + + + + +@array: +@func: +@data: + + + + + + + +@array: +@pos: +@Returns: + + + + + + + +@array: +@pos: +@value: +@Returns: + + + + + + + +@size: +@Returns: + + + + + + + +@array: +@pos: +@Returns: + + + + + + + +@array: +@pos: +@value: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/buffer.sgml b/doc/gtkdoc/tmpl/buffer.sgml new file mode 100644 index 0000000..1af330a --- /dev/null +++ b/doc/gtkdoc/tmpl/buffer.sgml @@ -0,0 +1,86 @@ + +Buffer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@buffer: + + + + + + + +@buffer: +@Returns: + + + + + + + +@buffer: +@Returns: + + + + + + + +@size: +@data: +@Returns: + + + + + + + +@buffer: +@offset: +@data: +@size: +@Returns: + + + + + + + +@buffer: +@size: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/config.sgml b/doc/gtkdoc/tmpl/config.sgml new file mode 100644 index 0000000..2dc8445 --- /dev/null +++ b/doc/gtkdoc/tmpl/config.sgml @@ -0,0 +1,137 @@ + +Config + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@section: +@priv: + + + + + + + +@variable: +@value: +@priv: + + + + + + + +@config: + + + + + + + +@config: +@callback: +@priv: + + + + + + + +@config: +@section: +@callback: +@priv: + + + + + + + +@config: +@section: +@variable: +@Returns: + + + + + + + +@config: +@filename: +@Returns: + + + + + + + +@void: +@Returns: + + + + + + + +@config: +@Returns: + + + + + + + +@config: +@filename: +@Returns: + + + + + + + +@config: +@section: +@variable: +@value: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/error.sgml b/doc/gtkdoc/tmpl/error.sgml new file mode 100644 index 0000000..81de170 --- /dev/null +++ b/doc/gtkdoc/tmpl/error.sgml @@ -0,0 +1,81 @@ + +Error + + + + + + + + + + + + + + + + + + + + + + + + + +@void: +@Returns: + + + + + + + +@code: +@Returns: + + + + + + + +@program: +@Returns: + + + + + + + +@format: +@...: + + + + + + + +@code: +@format: +@...: +@Returns: + + + + + + + +@program: +@code: +@format: +@...: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/event.sgml b/doc/gtkdoc/tmpl/event.sgml new file mode 100644 index 0000000..e072734 --- /dev/null +++ b/doc/gtkdoc/tmpl/event.sgml @@ -0,0 +1,147 @@ + +Event + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@fd: +@data: +@Returns: + + + + + + + +@data: +@Returns: + + + + + + + +@event: + + + + + + + +@event: +@Returns: + + + + + + + +@event: + + + + + + + +@void: +@Returns: + + + + + + + +@event: +@fd: +@func: +@userdata: +@Returns: + + + + + + + +@event: +@fd: +@func: +@userdata: +@Returns: + + + + + + + +@event: +@timeout: +@func: +@userdata: +@Returns: + + + + + + + +@event: +@fd: +@Returns: + + + + + + + +@event: +@fd: +@Returns: + + + + + + + +@event: +@func: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/file.sgml b/doc/gtkdoc/tmpl/file.sgml new file mode 100644 index 0000000..dd1236e --- /dev/null +++ b/doc/gtkdoc/tmpl/file.sgml @@ -0,0 +1,76 @@ + +File + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@file: + + + + + + + +@path: +@mode: +@Returns: + + + + + + + +@file: +@buf: +@size: +@count: +@Returns: + + + + + + + +@file: +@buf: +@size: +@count: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/hash.sgml b/doc/gtkdoc/tmpl/hash.sgml new file mode 100644 index 0000000..5ac7bef --- /dev/null +++ b/doc/gtkdoc/tmpl/hash.sgml @@ -0,0 +1,134 @@ + +Hash + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@value1: +@value2: +@Returns: + + + + + + + +@key: +@value: +@data: + + + + + + + +@value1: +@value2: +@Returns: + + + + + + + +@hash: +@Returns: + + + + + + + +@h: + + + + + + + +@hash: +@func: +@data: + + + + + + + +@value: +@Returns: + + + + + + + +@h: +@key: +@Returns: + + + + + + + +@func: +@compare: +@Returns: + + + + + + + +@hash: +@Returns: + + + + + + + +@h: +@key: +@value: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/libSystem-unused.sgml b/doc/gtkdoc/tmpl/libSystem-unused.sgml new file mode 100644 index 0000000..e69de29 diff --git a/doc/gtkdoc/tmpl/object.sgml b/doc/gtkdoc/tmpl/object.sgml new file mode 100644 index 0000000..2ff47fa --- /dev/null +++ b/doc/gtkdoc/tmpl/object.sgml @@ -0,0 +1,55 @@ + +Object + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@object: + + + + + + + +@size: +@Returns: + + + + + + + +@object: +@size: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/parser.sgml b/doc/gtkdoc/tmpl/parser.sgml new file mode 100644 index 0000000..894c718 --- /dev/null +++ b/doc/gtkdoc/tmpl/parser.sgml @@ -0,0 +1,157 @@ + +Parser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@parser: +@token: +@c: +@data: +@Returns: + + + + + + + +@c: +@data: +@Returns: + + + + + + + +@parser: +@callback: +@data: +@Returns: + + + + + + + +@parser: +@filter: +@data: +@Returns: + + + + + + + +@parser: +@Returns: + + + + + + + +@parser: +@Returns: + + + + + + + +@parser: +@token: +@Returns: + + + + + + + +@pathname: +@Returns: + + + + + + + +@string: +@length: +@Returns: + + + + + + + +@parser: +@callback: +@Returns: + + + + + + + +@parser: +@filter: +@Returns: + + + + + + + +@parser: +@Returns: + + + + + + + +@parser: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/plugin.sgml b/doc/gtkdoc/tmpl/plugin.sgml new file mode 100644 index 0000000..d69d023 --- /dev/null +++ b/doc/gtkdoc/tmpl/plugin.sgml @@ -0,0 +1,67 @@ + +Plugin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@plugin: + + + + + + + +@plugin: +@symbol: +@Returns: + + + + + + + +@libdir: +@package: +@type: +@name: +@Returns: + + + + + + + +@void: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/project.conf b/doc/gtkdoc/tmpl/project.conf new file mode 100644 index 0000000..ff48419 --- /dev/null +++ b/doc/gtkdoc/tmpl/project.conf @@ -0,0 +1 @@ +dist=Makefile,System.sgml,array.sgml,buffer.sgml,config.sgml,error.sgml,event.sgml,file.sgml,hash.sgml,libSystem-unused.sgml,object.sgml,parser.sgml,plugin.sgml,string.sgml,token.sgml diff --git a/doc/gtkdoc/tmpl/string.sgml b/doc/gtkdoc/tmpl/string.sgml new file mode 100644 index 0000000..eed79ff --- /dev/null +++ b/doc/gtkdoc/tmpl/string.sgml @@ -0,0 +1,173 @@ + +String + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@string: +@append: +@Returns: + + + + + + + +@string: + + + + + + + +@string: +@string2: +@Returns: + + + + + + + +@string: +@string2: +@length: +@Returns: + + + + + + + +@string: +@length: + + + + + + + +@string: + + + + + + + +@string: +@separator: +@Returns: + + + + + + + +@string: +@key: +@Returns: + + + + + + + +@string: +@key: +@Returns: + + + + + + + +@string: +@Returns: + + + + + + + +@string: +@Returns: + + + + + + + +@string: +@...: +@Returns: + + + + + + + +@string: +@length: +@Returns: + + + + + + + +@string: +@what: +@by: +@Returns: + + + + + + + +@string: +@string2: +@Returns: + + diff --git a/doc/gtkdoc/tmpl/token.sgml b/doc/gtkdoc/tmpl/token.sgml new file mode 100644 index 0000000..a40d6e4 --- /dev/null +++ b/doc/gtkdoc/tmpl/token.sgml @@ -0,0 +1,175 @@ + +Token + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@token: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@Returns: + + + + + + + +@token: +@set: +@Returns: + + + + + + + +@token: +@code: + + + + + + + +@token: +@col: + + + + + + + +@token: +@data: + + + + + + + +@token: +@filename: +@Returns: + + + + + + + +@token: +@line: + + + + + + + +@token: +@string: +@Returns: + + diff --git a/doc/project.conf b/doc/project.conf index 5fd2018..925c663 100644 --- a/doc/project.conf +++ b/doc/project.conf @@ -1,5 +1,5 @@ subdirs=gtkdoc -targets=gtkdoc/libSystem.types,gtkdoc/sgml.stamp,html/index.html +targets=gtkdoc/libSystem.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp dist=Makefile,gtkdoc.sh [gtkdoc/libSystem.types] @@ -9,9 +9,14 @@ script=./gtkdoc.sh [gtkdoc/sgml.stamp] type=script script=./gtkdoc.sh -depends=gtkdoc/libSystem.types +depends=gtkdoc/tmpl.stamp -[html/index.html] +[gtkdoc/tmpl.stamp] type=script script=./gtkdoc.sh -depends=gtkdoc/libSystem-docs.xml,gtkdoc/sgml.stamp +depends=gtkdoc/libSystem.types + +[gtkdoc/html.stamp] +type=script +script=./gtkdoc.sh +depends=gtkdoc/libSystem-docs.xml,gtkdoc/sgml.stamp,gtkdoc/tmpl.stamp