[docs] xmldocs - docelic modified 2 files

docs at icdevgroup.org docs at icdevgroup.org
Fri Jul 30 12:21:42 EDT 2004


User:      docelic
Date:      2004-07-30 16:21:42 GMT
Modified:  .        Makefile
Added:     .        TODO
Log:
- Makefile:
  - In the stattrees target, added ctags generation

- TODO:
  - Added a TODO list (it's up for grabs ;)

Revision  Changes    Path
1.8       +7 -21     xmldocs/Makefile


rev 1.8, prev_rev 1.7
Index: Makefile
===================================================================
RCS file: /var/cvs/xmldocs/Makefile,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- Makefile	23 Jul 2004 13:32:01 -0000	1.7
+++ Makefile	30 Jul 2004 16:21:42 -0000	1.8
@@ -106,9 +106,15 @@
 # STATTREE
 tmp/stattrees:
 	-for p in $(IC_VERSIONS); do \
-	./bin/stattree sources/$$p \
+	./bin/stattree sources/$$p; \
+	ctags -R -x --languages=perl --perl-kinds=cls sources/$$p/ \
+	> cache/$$p/.objectlist.perl.txt; \
+	ctags -R -x --languages=c --c-kinds=cdf sources/$$p/ \
+	> cache/$$p/.objectlist.c.txt; \
+	ctags -f cache/$$p/.tags -R --extra=fq --fields=afikKlmnsSz --line-directives sources/$$p \
 	; done
 
+
 #
 # Cleanup
 #
@@ -126,10 +132,6 @@
 #
 # OlinkDBs
 #
-# TODO OlinkDB targets get properly called implicitly by 
-# the above targets, but SOMEHOW the tmp/*.db files are not created.
-# Everything works fine if you run it manually. I really don't know
-# the problem here.
 # OlinkDB information for unchunked parts
 #$(LTMPDIR)/%-nc.db: %.xml $(LTMPDIR)
 #	$(XSLT) $(XSLT_FLAGS)                                          \
@@ -144,22 +146,6 @@
 #	--stringparam targets.filename $@                              \
 #	docbook/html-chunks.xsl $<
 #
-#
-#	# Generate human-readable ctags information
-#	-for p in $(IC_VERSIONS); do \
-#		ctags -R -x --languages=perl --perl-kinds=cls sources/$$p/ \
-#		> $(CACHE)/$$p/.objectlist.perl.txt; \
-#		ctags -R -x --languages=c --c-kinds=cdf sources/$$p/ \
-#		> $(CACHE)/$$p/.objectlist.c.txt; \
-#		cd sources \
-#	; done
-#
-#tags:
-#	# Generate ctags information
-#	-for p in $(IC_VERSIONS); do \
-#		ctags -f $(CACHE)/$$p/.tags -R --extra=fq --fields=afikKlmnsSz --line-directives sources/$$p; \
-#		cd sources \
-#	; done
 #
 ## TODO Make target that conveniently checks out all IC releases from CVS
 #



1.1                  xmldocs/TODO


rev 1.1, prev_rev 1.0
Index: TODO
===================================================================

DOCUMENTATION SYSTEM:
- Make items in the See Also section to appear as links to the 
  appropriate items.
- For reference pages, make Examples appear without the "Example XY"
  prefix.
- See why each Example has weird characters around the example index number
  (it renders badly in manpages).
- In bin/stattree, when extracting symbol context, also try to determine
  function name in question and print its name in Context header (along with
  filename/line number).
- Make more use of docbook/catalog.xml

 Long-term:
- Support using refs/<filename> with all the documentation for a symbol
  instead of refs/<directory>/<files>.


DOCUMENTATION ITSELF:
- Resolve items from tmp/missing file. (You need to run 'make' in your tree
  first, to get that file generated).








More information about the docs mailing list