Changeset 4218Tweet

Timestamp:

Jan 3, 2010, 3:32:57 AM (11 years ago)

Author:

Sam Hocevar

Message:

Add Doxygen build rules.

Location:

neercs/trunk

Files:

• .gitignore (modified) (2 diffs)
• Makefile.am (modified) (1 diff)
• configure.ac (modified) (2 diffs)
• doc/Makefile.am (modified) (1 diff)
• doc/doxygen.cfg.in (added)
• doc/doxygen.css (added)
• doc/footer.html (added)
• doc/header.html (added)
• doc/neercs.dox (added)
• src/client.c (modified) (1 diff)
• src/neercs.h (modified) (1 diff)

neercs/trunk/.gitignore

@@ +1 @@
+# Autotools cruft
 *.o
 *.lo
@@ -18 +19 @@
 stamp-*
 *-stamp
+# Binaries
 src/neercs
+# Documentation
+doc/doxygen.cfg
+doc/html/
+doc/latex/
+

neercs/trunk/Makefile.am

@@ -1 +1 @@
 
-SUBDIRS = src
-DIST_SUBDIRS = $(SUBDIRS) data doc
+SUBDIRS = src doc
+DIST_SUBDIRS = $(SUBDIRS) data
 
 EXTRA_DIST = bootstrap
 AUTOMAKE_OPTIONS = foreign dist-bzip2
 
+webhost = poulet.zoy.org
+webdir = /srv/caca.zoy.org/var/www/
+doxdir = /srv/caca.zoy.org/var/cache/doxygen/neercs
+
+upload: upload-source upload-doc
+
+upload-source: FORCE
+        scp $(distdir).tar.gz $(webhost):$(webdir)/files/
+
+upload-doc: doc/html FORCE
+        ssh $(webhost) rm -f '$(doxdir)/*' || true
+        scp -r doc/html/* $(webhost):$(doxdir)/
+
+FORCE:

neercs/trunk/configure.ac

@@ -144 +144 @@
 fi
 
-
 # Code qui fait des warnings == code de porc == deux baffes dans ta gueule
 CFLAGS="${CFLAGS} -Wall -Wpointer-arith -Wcast-align -Wcast-qual -Wstrict-prototypes -Wshadow -Waggregate-return -Wmissing-prototypes -Wnested-externs -Wsign-compare"
 
-AC_OUTPUT([
+# Build documentation?
+DOXYGEN="no"
+LATEX="no"
+if test "${enable_doc}" != "no"; then
+  AC_PATH_PROG(DOXYGEN, doxygen, no)
+  if test "${DOXYGEN}" != "no"; then
+    # Build LaTeX documentation?
+    AC_PATH_PROG(LATEX, pdflatex, no)
+    AC_PATH_PROG(KPSEWHICH, kpsewhich, no)
+    AC_PATH_PROG(DVIPS, dvips, no)
+    if test "${DVIPS}" = "no" -o "${KPSEWHICH}" = "no"; then
+      LATEX="no"
+    fi
+    if test "${LATEX}" != "no"; then
+      AC_MSG_CHECKING(for a4.sty and a4wide.sty)
+      if "${KPSEWHICH}" a4.sty >/dev/null 2>&1; then
+        if "${KPSEWHICH}" a4wide.sty >/dev/null 2>&1; then
+          AC_MSG_RESULT(yes)
+        else
+          LATEX="no"
+          AC_MSG_RESULT(no)
+        fi
+      else
+        LATEX="no"
+        AC_MSG_RESULT(no)
+      fi
+    fi
+  fi
+fi
+AM_CONDITIONAL(BUILD_DOCUMENTATION, test "${DOXYGEN}" != "no")
+AM_CONDITIONAL(USE_LATEX, test "${LATEX}" != "no")
+
+AC_CONFIG_FILES([
   Makefile
   doc/Makefile
@@ -154 +185 @@
   data/Makefile
 ])
+AC_CONFIG_FILES([
+  doc/doxygen.cfg
+])
+AC_OUTPUT
 

neercs/trunk/doc/Makefile.am

@@ -1 +1 @@
 # $Id: Makefile.am 1986 2008-06-20 19:49:23Z jylam $
 
-EXTRA_DIST = $(man_MANS)
+EXTRA_DIST = doxygen.cfg.in doxygen.css footer.html header.html \
+             $(man_MANS) $(doxygen_DOX)
 
+doxygen_DOX = neercs.dox
 man_MANS = neercs.1
+
+if BUILD_DOCUMENTATION
+htmldoc_DATA = html/doxygen.css
+htmldocdir = $(datadir)/doc/neercs/html
+if USE_LATEX
+pdfdoc_DATA = latex/neercs.pdf
+pdfdocdir = $(datadir)/doc/neercs/pdf
+endif
+endif
+
+html/doxygen.css html/doxygen.png: stamp-doxygen
+latex/neercs.pdf: stamp-latex
+
+stamp-doxygen: $(doxygen_DOX) doxygen.cfg
+if BUILD_DOCUMENTATION
+        doxygen doxygen.cfg
+        touch stamp-doxygen
+endif
+
+stamp-latex: stamp-doxygen
+if BUILD_DOCUMENTATION
+if USE_LATEX
+        rm -f latex/neercs.tex latex/neercs.pdf
+        mv latex/refman.tex latex/neercs.tex
+        sed 's/setlength{/renewcommand{/' latex/neercs.tex > latex/refman.tex
+        cd latex && $(MAKE) $(AM_CFLAGS) refman.pdf || (cat refman.log; exit 1)
+        mv latex/refman.pdf latex/neercs.pdf
+        touch stamp-latex
+endif
+endif
+
+clean: clean-local
+clean-local:
+        -rm -Rf html latex man
+        -rm -f stamp-latex stamp-doxygen
 
 install-data-local:
         $(mkinstalldirs) $(DESTDIR)$(mandir)/man1
+if BUILD_DOCUMENTATION
+        mkdir -p $(DESTDIR)$(datadir)/doc
+        $(mkinstalldirs) $(DESTDIR)$(datadir)/doc/neercs/html
+        cp `find html -name '*.html' -o -name '*.gif' -o -name '*.png'` \
+          $(DESTDIR)$(datadir)/doc/neercs/html
+        $(mkinstalldirs) $(DESTDIR)$(mandir)/man3
+        for man in $$(find man -name '*.3neercs'); do \
+          sed -e 's/man3neercs/man3/g' -e "s/fC'\([a-zA-Z0-9]*\)'/fC\"\1\"/g" \
+            $$man >$(DESTDIR)$(mandir)/man3/$${man##*/}; \
+        done
+endif
 
+uninstall-local:
+        rmdir $(DESTDIR)$(datadir)/doc 2>/dev/null || true
+

neercs/trunk/src/client.c

@@ -164 +164 @@
 }
 
-/*
- * The main client loop.
+/** \brief Main client loop.
+ *
+ * This is the main client loop.
  *
  * Repeat forever:

neercs/trunk/src/neercs.h

@@ -300 +300 @@
 
 int start_client(struct screen_list * screen_list);
+/** \defgroup client neercs client
+ * @{ */
 void mainloop(struct screen_list *screen_list);
+/** }@ */
+
 
 int create_pty(char *cmd, unsigned int w, unsigned int h, int *cpid);