diff options
author | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2012-10-12 11:22:37 +0200 |
---|---|---|
committer | Kjell Ahlstedt <kjell.ahlstedt@bredband.net> | 2012-10-12 11:22:37 +0200 |
commit | bb73b0c8a6ca574797acf21afa3fea3f9188f196 (patch) | |
tree | e53e7ec481714e552e1cc76d5ff6572721f9563d | |
parent | ec940f0ae574b0aa7e3b530ba71e786df17ee202 (diff) | |
download | mm-common-bb73b0c8a6ca574797acf21afa3fea3f9188f196.tar.gz |
Update skeletonmm.
* skeletonmm/.gitignore: Add files copied by MM_CONFIG_DOCTOOL_DIR([doc]).
* skeletonmm/codegen/generate_defs_and_docs.sh: New file.
* skeletonmm/codegen/Makefile.am: Include generate_defs_and_docs.sh in
distribution.
* skeletonmm/doc/reference/Doxyfile.in: Make it more like Doxyfile.in
in glibmm and gtkmm.
Add ALIAS for @newin with 3 arguments. Some C projects (goocanvas, grilo,
gstreamer) use "Since: 1.2.3", instead of "Since: 1.2".
* skeletonmm/skeleton/src/skeleton_extra.defs: Rename to skeleton_signal.defs.
* skeletonmm/skeleton/src/skeleton_vfunc.defs: New file
* skeletonmm/skeleton/src/skeleton.defs:
* skeletonmm/skeleton/src/filelist.am: Update with new and renamed files.
-rw-r--r-- | skeletonmm/.gitignore | 12 | ||||
-rw-r--r-- | skeletonmm/codegen/Makefile.am | 5 | ||||
-rwxr-xr-x | skeletonmm/codegen/generate_defs_and_docs.sh | 39 | ||||
-rw-r--r-- | skeletonmm/doc/reference/Doxyfile.in | 15 | ||||
-rw-r--r-- | skeletonmm/skeleton/src/filelist.am | 13 | ||||
-rw-r--r-- | skeletonmm/skeleton/src/skeleton.defs | 3 | ||||
-rw-r--r-- | skeletonmm/skeleton/src/skeleton_signal.defs (renamed from skeletonmm/skeleton/src/skeleton_extra.defs) | 0 | ||||
-rw-r--r-- | skeletonmm/skeleton/src/skeleton_vfunc.defs | 13 |
8 files changed, 84 insertions, 16 deletions
diff --git a/skeletonmm/.gitignore b/skeletonmm/.gitignore index bb0d047..18bbe0b 100644 --- a/skeletonmm/.gitignore +++ b/skeletonmm/.gitignore @@ -1,3 +1,4 @@ +# wildcard patterns .deps/ .dirstamp .libs/ @@ -6,6 +7,8 @@ Makefile.in stamp-h? *.[ao] *.l[ao] + +# ./ /INSTALL /aclocal.m4 /autom4te.cache/ @@ -15,4 +18,13 @@ stamp-h? /configure /skeletonmm-*.tar.* /libtool + +# codegen/ /codegen/extradefs/generate_extra_defs + +# doc/ +/doc/doc-install.pl +/doc/doc-postprocess.pl +/doc/doxygen.css +/doc/tagfile-to-devhelp2.xsl + diff --git a/skeletonmm/codegen/Makefile.am b/skeletonmm/codegen/Makefile.am index 412aec0..c846d71 100644 --- a/skeletonmm/codegen/Makefile.am +++ b/skeletonmm/codegen/Makefile.am @@ -19,8 +19,9 @@ AUTOMAKE_OPTIONS = subdir-objects include $(srcdir)/m4/filelist.am -dist_noinst_DATA = $(addprefix m4/,$(files_codegen_m4)) -noinst_PROGRAMS = extradefs/generate_extra_defs +dist_noinst_DATA = $(addprefix m4/,$(files_codegen_m4)) +dist_noinst_SCRIPTS = generate_defs_and_docs.sh +noinst_PROGRAMS = extradefs/generate_extra_defs extradefs_generate_extra_defs_SOURCES = extradefs/generate_extra_defs_skeleton.cc extradefs_generate_extra_defs_LDADD = $(SKELETONMM_LIBS) -lglibmm_generate_extra_defs-2.4 diff --git a/skeletonmm/codegen/generate_defs_and_docs.sh b/skeletonmm/codegen/generate_defs_and_docs.sh new file mode 100755 index 0000000..724b356 --- /dev/null +++ b/skeletonmm/codegen/generate_defs_and_docs.sh @@ -0,0 +1,39 @@ +#!/bin/bash + +# skeletonmm/codegen/generate_defs_and_docs.sh + +# This script must be executed from directory skeletonmm/codegen. + +# Assumed directory structure: +# glibmm/tools/defs_gen/docextract_to_xml.py +# glibmm/tools/defs_gen/h2def.py +# glibmm/tools/enum.pl +# skeleton/src/*.h +# skeleton/src/*.c +# skeletonmm/codegen/extradefs/generate_extra_defs + +# Generated files: +# skeletonmm/skeleton/src/skeleton_docs.xml +# skeletonmm/skeleton/src/skeleton_enum.defs +# skeletonmm/skeleton/src/skeleton_method.defs +# skeletonmm/skeleton/src/skeleton_signal.defs + +GLIBMM_TOOLS_DIR=../../glibmm/tools +SKELETON_DIR=../../skeleton +SKELETONMM_SKELETON_SRC_DIR=../skeleton/src + +$GLIBMM_TOOLS_DIR/defs_gen/docextract_to_xml.py \ + -s $SKELETON_DIR/src \ + >$SKELETONMM_SKELETON_SRC_DIR/skeleton_docs.xml + +$GLIBMM_TOOLS_DIR/enum.pl \ + $SKELETON_DIR/src/*.h \ + >$SKELETONMM_SKELETON_SRC_DIR/skeleton_enum.defs + +$GLIBMM_TOOLS_DIR/defs_gen/h2def.py \ + $SKELETON_DIR/src/*.h \ + >$SKELETONMM_SKELETON_SRC_DIR/skeleton_method.defs + +extradefs/generate_extra_defs \ + >$SKELETONMM_SKELETON_SRC_DIR/skeleton_signal.defs + diff --git a/skeletonmm/doc/reference/Doxyfile.in b/skeletonmm/doc/reference/Doxyfile.in index f7904d7..5dbb5dd 100644 --- a/skeletonmm/doc/reference/Doxyfile.in +++ b/skeletonmm/doc/reference/Doxyfile.in @@ -32,6 +32,7 @@ INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 ALIASES = "newin{2}=\xrefitem since_\1_\2 \"Since @PACKAGE_NAME@ \1.\2\" \"New API in @PACKAGE_NAME@ \1.\2\"" +ALIASES += "newin{3}=\xrefitem since_\1_\2_\3 \"Since @PACKAGE_NAME@ \1.\2.\3\" \"New API in @PACKAGE_NAME@ \1.\2.\3\"" OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO @@ -48,14 +49,14 @@ SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -EXTRACT_ALL = NO -EXTRACT_PRIVATE = YES +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO EXTRACT_LOCAL_CLASSES = NO EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = YES -HIDE_UNDOC_CLASSES = YES +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO HIDE_FRIEND_COMPOUNDS = YES HIDE_IN_BODY_DOCS = YES INTERNAL_DOCS = NO @@ -87,7 +88,7 @@ QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = YES +WARN_NO_PARAMDOC = NO WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = reference/doxygen.log #--------------------------------------------------------------------------- @@ -131,7 +132,7 @@ VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO +ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 IGNORE_PREFIX = #--------------------------------------------------------------------------- @@ -165,7 +166,7 @@ QHP_SECT_FILTER_ATTRS = QHG_LOCATION = DISABLE_INDEX = NO ENUM_VALUES_PER_LINE = 1 -GENERATE_TREEVIEW = NONE +GENERATE_TREEVIEW = NO USE_INLINE_TREES = NO TREEVIEW_WIDTH = 250 FORMULA_FONTSIZE = 10 diff --git a/skeletonmm/skeleton/src/filelist.am b/skeletonmm/skeleton/src/filelist.am index 6f64020..4dcceb2 100644 --- a/skeletonmm/skeleton/src/filelist.am +++ b/skeletonmm/skeleton/src/filelist.am @@ -1,11 +1,12 @@ ## This file is part of skeletonmm. -files_defs = \ - skeleton.defs \ - skeleton_enum.defs \ - skeleton_extra.defs \ - skeleton_method.defs \ - skeleton_docs.xml +files_defs = \ + skeleton.defs \ + skeleton_enum.defs \ + skeleton_method.defs \ + skeleton_signal.defs \ + skeleton_vfunc.defs \ + skeleton_docs.xml files_hg = skeleton.hg files_ccg = $(files_hg:.hg=.ccg) diff --git a/skeletonmm/skeleton/src/skeleton.defs b/skeletonmm/skeleton/src/skeleton.defs index f60b7e3..a2ffe9e 100644 --- a/skeletonmm/skeleton/src/skeleton.defs +++ b/skeletonmm/skeleton/src/skeleton.defs @@ -1,4 +1,5 @@ ;; Include generated API definition files (include skeleton_enum.defs) (include skeleton_method.defs) -(include skeleton_extra.defs) +(include skeleton_signal.defs) +(include skeleton_vfunc.defs) diff --git a/skeletonmm/skeleton/src/skeleton_extra.defs b/skeletonmm/skeleton/src/skeleton_signal.defs index b244442..b244442 100644 --- a/skeletonmm/skeleton/src/skeleton_extra.defs +++ b/skeletonmm/skeleton/src/skeleton_signal.defs diff --git a/skeletonmm/skeleton/src/skeleton_vfunc.defs b/skeletonmm/skeleton/src/skeleton_vfunc.defs new file mode 100644 index 0000000..24df0f9 --- /dev/null +++ b/skeletonmm/skeleton/src/skeleton_vfunc.defs @@ -0,0 +1,13 @@ +; Virtual functions +; Hand-written file + +; SkeletonSomeType + +;(define-vfunc some_vfunc +; (of-object "SkeletonSomeType") +; (return-type "void") +; (parameters +; '("GObject*" "some_object") +; '("const-gchar*" "some_string") +; ) +;) |