Importing the first gtk-doc templates
This commit is contained in:
parent
e406835fc9
commit
15d21d2bfc
16
Makefile
16
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 \
|
||||
|
|
|
|||
15
doc/Makefile
15
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)
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1 +1,2 @@
|
|||
subdirs=tmpl
|
||||
dist=Makefile,libSystem-docs.xml
|
||||
|
|
|
|||
13
doc/gtkdoc/tmpl/Makefile
Normal file
13
doc/gtkdoc/tmpl/Makefile
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
|
||||
|
||||
all:
|
||||
|
||||
clean:
|
||||
|
||||
distclean: clean
|
||||
|
||||
install:
|
||||
|
||||
uninstall:
|
||||
|
||||
.PHONY: all clean distclean install uninstall
|
||||
22
doc/gtkdoc/tmpl/System.sgml
Normal file
22
doc/gtkdoc/tmpl/System.sgml
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
System
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
134
doc/gtkdoc/tmpl/array.sgml
Normal file
134
doc/gtkdoc/tmpl/array.sgml
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Array
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### MACRO ARRAY ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@type:
|
||||
@name:
|
||||
|
||||
|
||||
<!-- ##### STRUCT Array ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION ArrayForeach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_append ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_count ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@func:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@pos:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_get_copy ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@pos:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_remove_pos ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@pos:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION array_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@array:
|
||||
@pos:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
86
doc/gtkdoc/tmpl/buffer.sgml
Normal file
86
doc/gtkdoc/tmpl/buffer.sgml
Normal file
|
|
@ -0,0 +1,86 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Buffer
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT Buffer ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_get_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_get_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@size:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_set_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@offset:
|
||||
@data:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION buffer_set_size ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@buffer:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
137
doc/gtkdoc/tmpl/config.sgml
Normal file
137
doc/gtkdoc/tmpl/config.sgml
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Config
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF Config ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION ConfigForeachCallback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@section:
|
||||
@priv:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION ConfigForeachSectionCallback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@variable:
|
||||
@value:
|
||||
@priv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@callback:
|
||||
@priv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_foreach_section ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@section:
|
||||
@callback:
|
||||
@priv:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@section:
|
||||
@variable:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_load ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@filename:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@void:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_reset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_save ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@filename:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION config_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@config:
|
||||
@section:
|
||||
@variable:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
81
doc/gtkdoc/tmpl/error.sgml
Normal file
81
doc/gtkdoc/tmpl/error.sgml
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Error
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@void:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_get_code ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@code:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_print ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@program:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@format:
|
||||
@...:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_set_code ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@code:
|
||||
@format:
|
||||
@...:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION error_set_print ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@program:
|
||||
@code:
|
||||
@format:
|
||||
@...:
|
||||
@Returns:
|
||||
|
||||
|
||||
147
doc/gtkdoc/tmpl/event.sgml
Normal file
147
doc/gtkdoc/tmpl/event.sgml
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Event
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT Event ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION EventIOFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@fd:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION EventTimeoutFunc ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_loop ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_loop_quit ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@void:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_register_io_read ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@fd:
|
||||
@func:
|
||||
@userdata:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_register_io_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@fd:
|
||||
@func:
|
||||
@userdata:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_register_timeout ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@timeout:
|
||||
@func:
|
||||
@userdata:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_unregister_io_read ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@fd:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_unregister_io_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@fd:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION event_unregister_timeout ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@event:
|
||||
@func:
|
||||
@Returns:
|
||||
|
||||
|
||||
76
doc/gtkdoc/tmpl/file.sgml
Normal file
76
doc/gtkdoc/tmpl/file.sgml
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
File
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT File ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF FileMode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION file_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@file:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION file_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@path:
|
||||
@mode:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION file_read ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@file:
|
||||
@buf:
|
||||
@size:
|
||||
@count:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION file_write ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@file:
|
||||
@buf:
|
||||
@size:
|
||||
@count:
|
||||
@Returns:
|
||||
|
||||
|
||||
134
doc/gtkdoc/tmpl/hash.sgml
Normal file
134
doc/gtkdoc/tmpl/hash.sgml
Normal file
|
|
@ -0,0 +1,134 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Hash
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT Hash ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION HashCompare ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION HashForeach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@key:
|
||||
@value:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_compare_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value1:
|
||||
@value2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_count ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@h:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_foreach ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash:
|
||||
@func:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_func_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_get ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@h:
|
||||
@key:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@func:
|
||||
@compare:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_reset ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@hash:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION hash_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@h:
|
||||
@key:
|
||||
@value:
|
||||
@Returns:
|
||||
|
||||
|
||||
0
doc/gtkdoc/tmpl/libSystem-unused.sgml
Normal file
0
doc/gtkdoc/tmpl/libSystem-unused.sgml
Normal file
55
doc/gtkdoc/tmpl/object.sgml
Normal file
55
doc/gtkdoc/tmpl/object.sgml
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Object
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF Object ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION object_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION object_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION object_resize ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@object:
|
||||
@size:
|
||||
@Returns:
|
||||
|
||||
|
||||
157
doc/gtkdoc/tmpl/parser.sgml
Normal file
157
doc/gtkdoc/tmpl/parser.sgml
Normal file
|
|
@ -0,0 +1,157 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Parser
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### STRUCT Parser ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION ParserCallback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@token:
|
||||
@c:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### USER_FUNCTION ParserFilter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@c:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_add_callback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@callback:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_add_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@filter:
|
||||
@data:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_get_filename ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_get_token ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@pathname:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_new_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@length:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_remove_callback ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@callback:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_remove_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@filter:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_scan ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION parser_scan_filter ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@parser:
|
||||
@Returns:
|
||||
|
||||
|
||||
67
doc/gtkdoc/tmpl/plugin.sgml
Normal file
67
doc/gtkdoc/tmpl/plugin.sgml
Normal file
|
|
@ -0,0 +1,67 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Plugin
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF Plugin ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION plugin_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION plugin_lookup ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@plugin:
|
||||
@symbol:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION plugin_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@libdir:
|
||||
@package:
|
||||
@type:
|
||||
@name:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION plugin_new_self ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@void:
|
||||
@Returns:
|
||||
|
||||
|
||||
1
doc/gtkdoc/tmpl/project.conf
Normal file
1
doc/gtkdoc/tmpl/project.conf
Normal file
|
|
@ -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
|
||||
173
doc/gtkdoc/tmpl/string.sgml
Normal file
173
doc/gtkdoc/tmpl/string.sgml
Normal file
|
|
@ -0,0 +1,173 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
String
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF String ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_append ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@append:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_clear ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_compare ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@string2:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_compare_length ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@string2:
|
||||
@length:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_cut ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@length:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_explode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@separator:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_find ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@key:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_index ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@key:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_length ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_new ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_new_append ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@...:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_new_length ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@length:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_replace ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@what:
|
||||
@by:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION string_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@string:
|
||||
@string2:
|
||||
@Returns:
|
||||
|
||||
|
||||
175
doc/gtkdoc/tmpl/token.sgml
Normal file
175
doc/gtkdoc/tmpl/token.sgml
Normal file
|
|
@ -0,0 +1,175 @@
|
|||
<!-- ##### SECTION Title ##### -->
|
||||
Token
|
||||
|
||||
<!-- ##### SECTION Short_Description ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Long_Description ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION See_Also ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
<!-- ##### SECTION Stability_Level ##### -->
|
||||
|
||||
|
||||
<!-- ##### SECTION Image ##### -->
|
||||
|
||||
|
||||
<!-- ##### MACRO TC_NULL ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
|
||||
<!-- ##### STRUCT Token ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF TokenCode ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### TYPEDEF TokenSet ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_delete ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_code ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_col ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_filename ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_line ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_get_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_in_set ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@set:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_code ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@code:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_col ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@col:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_data ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@data:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_filename ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@filename:
|
||||
@Returns:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_line ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@line:
|
||||
|
||||
|
||||
<!-- ##### FUNCTION token_set_string ##### -->
|
||||
<para>
|
||||
|
||||
</para>
|
||||
|
||||
@token:
|
||||
@string:
|
||||
@Returns:
|
||||
|
||||
|
||||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user