Prechádzať zdrojové kódy

doc: Add doxygen support

The code should start getting switched to document using JavaDoc
style comments, at least for public declarations.
Guillem Jover 16 rokov pred
rodič
commit
876b512631
6 zmenil súbory, kde vykonal 1540 pridanie a 0 odobranie
  1. 8 0
      Makefile.am
  2. 3 0
      configure.ac
  3. 1 0
      debian/changelog
  4. 2 0
      doc/.gitignore
  5. 1521 0
      doc/Doxyfile.in
  6. 5 0
      doc/coding-style.txt

+ 8 - 0
Makefile.am

@@ -59,6 +59,14 @@ EXTRA_DIST = \
 	debian/shlibs.default \
 	debian/shlibs.override
 
+.PHONY: doc
+
+doc:
+	$(DOXYGEN) doc/Doxyfile
+
+clean-local:
+	rm -rf doc/html/
+
 .PHONY: ChangeLog
 DISTCLEANFILES = ChangeLog
 

+ 3 - 0
configure.ac

@@ -57,6 +57,8 @@ AC_PROG_CC
 AC_PROG_CXX
 AC_PROG_LEX
 AC_PROG_RANLIB
+AC_CHECK_PROGS([DOXYGEN], [doxygen])
+AC_CHECK_PROG([HAVE_DOT], [dot], [YES], [NO])
 DPKG_PROG_PERL
 
 # Checks for operating system services and capabilities.
@@ -118,6 +120,7 @@ AC_CONFIG_FILES([ Makefile
 		  lib/compat/Makefile
 		  lib/dpkg/Makefile
 		  lib/dpkg/test/Makefile
+		  doc/Doxyfile
 		  man/Makefile
 		  po/Makefile.in
 		  scripts/Makefile

+ 1 - 0
debian/changelog

@@ -31,6 +31,7 @@ dpkg (1.15.5) UNRELEASED; urgency=low
   * Fix build macros to allow start-stop-deaemon to use TIOCNOTTY.
   * Generate the autoconf version from git to make it easier to see when a
     snapshot version is being used.
+  * Add infrastructure for doxygen, for now not installed anywhere.
 
   [ Raphaël Hertzog ]
   * Add versioned dependency on base-files (>= 5.0.0) to dpkg-dev to ensure

+ 2 - 0
doc/.gitignore

@@ -0,0 +1,2 @@
+Doxyfile
+html

Rozdielové dáta súboru neboli zobrazené, pretože súbor je príliš veľký
+ 1521 - 0
doc/Doxyfile.in


+ 5 - 0
doc/coding-style.txt

@@ -41,6 +41,11 @@ other changes to be done on them, oterwise we get unneeded fuzzies.
 
   <http://www.cl.cam.ac.uk/~mgk25/ucs/quotes.html>
 
+Code documentation
+~~~~~~~~~~~~~~~~~~
+
+Public declarations should be documented using JavaDoc style comments.
+
 Indentation, alignment and spacing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~