Mercuriallemon / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
doc/Makefile.am
author Peter Kovacs <kpeter@inf.elte.hu>
Sat, 08 Jan 2011 22:51:16 +0100
changeset 1201 9a51db038228
parent 943 d48d79b11f5b
permissions -rw-r--r--
Document and greatly improve TSP algorithms (#386)

- Add LEMON headers.
- Add Doxygen doc for all classes and their members.
- Clarify and unify the public API of the algorithms.
- Various small improvements in the implementations to make
them clearer and faster.
- Avoid using adaptors in ChristofidesTsp. 
     1 EXTRA_DIST += \

     2 	doc/Doxyfile.in \

     3 	doc/DoxygenLayout.xml \

     4 	doc/coding_style.dox \

     5 	doc/dirs.dox \

     6 	doc/groups.dox \

     7 	doc/lgf.dox \

     8 	doc/license.dox \

     9 	doc/mainpage.dox \

    10 	doc/migration.dox \

    11 	doc/min_cost_flow.dox \

    12 	doc/named-param.dox \

    13 	doc/namespaces.dox \

    14 	doc/html \

    15 	doc/CMakeLists.txt

    16 

    17 DOC_EPS_IMAGES18 = \

    18 	grid_graph.eps \

    19 	nodeshape_0.eps \

    20 	nodeshape_1.eps \

    21 	nodeshape_2.eps \

    22 	nodeshape_3.eps \

    23 	nodeshape_4.eps

    24 

    25 DOC_EPS_IMAGES27 = \

    26 	bipartite_matching.eps \

    27 	bipartite_partitions.eps \

    28 	connected_components.eps \

    29 	edge_biconnected_components.eps \

    30 	matching.eps \

    31 	node_biconnected_components.eps \

    32 	planar.eps \

    33 	strongly_connected_components.eps \

    34 	tsp.eps

    35 

    36 DOC_EPS_IMAGES = \

    37 	$(DOC_EPS_IMAGES18) \

    38 	$(DOC_EPS_IMAGES27)

    39 

    40 DOC_PNG_IMAGES = \

    41 	$(DOC_EPS_IMAGES:%.eps=doc/gen-images/%.png)

    42 

    43 EXTRA_DIST += $(DOC_EPS_IMAGES:%=doc/images/%)

    44 

    45 doc/html:

    46 	$(MAKE) $(AM_MAKEFLAGS) html

    47 

    48 GS_COMMAND=gs -dNOPAUSE -dBATCH -q -dEPSCrop -dTextAlphaBits=4 -dGraphicsAlphaBits=4

    49 

    50 $(DOC_EPS_IMAGES18:%.eps=doc/gen-images/%.png): doc/gen-images/%.png: doc/images/%.eps

    51 	-mkdir doc/gen-images

    52 	if test ${gs_found} = yes; then \

    53 	  $(GS_COMMAND) -sDEVICE=pngalpha -r18 -sOutputFile=$@ $<; \

    54 	else \

    55 	  echo; \

    56 	  echo "Ghostscript not found."; \

    57 	  echo; \

    58 	  exit 1; \

    59 	fi

    60 

    61 $(DOC_EPS_IMAGES27:%.eps=doc/gen-images/%.png): doc/gen-images/%.png: doc/images/%.eps

    62 	-mkdir doc/gen-images

    63 	if test ${gs_found} = yes; then \

    64 	  $(GS_COMMAND) -sDEVICE=pngalpha -r27 -sOutputFile=$@ $<; \

    65 	else \

    66 	  echo; \

    67 	  echo "Ghostscript not found."; \

    68 	  echo; \

    69 	  exit 1; \

    70 	fi

    71 

    72 references.dox: doc/references.bib

    73 	if test ${python_found} = yes; then \

    74 	  cd doc; \

    75 	  python @abs_top_srcdir@/scripts/bib2dox.py @abs_top_builddir@/$< >$@; \

    76 	  cd ..; \

    77 	else \

    78 	  echo; \

    79 	  echo "Python not found."; \

    80 	  echo; \

    81 	  exit 1; \

    82 	fi

    83 

    84 html-local: $(DOC_PNG_IMAGES) references.dox

    85 	if test ${doxygen_found} = yes; then \

    86 	  cd doc; \

    87 	  doxygen Doxyfile; \

    88 	  cd ..; \

    89 	else \

    90 	  echo; \

    91 	  echo "Doxygen not found."; \

    92 	  echo; \

    93 	  exit 1; \

    94 	fi

    95 

    96 clean-local:

    97 	-rm -rf doc/html

    98 	-rm -f doc/doxygen.log

    99 	-rm -f $(DOC_PNG_IMAGES)

   100 	-rm -rf doc/gen-images

   101 

   102 update-external-tags:

   103 	wget -O doc/libstdc++.tag.tmp http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/libstdc++.tag && \

   104 	mv doc/libstdc++.tag.tmp doc/libstdc++.tag || \

   105 	rm doc/libstdc++.tag.tmp

   106 

   107 install-html-local: doc/html

   108 	@$(NORMAL_INSTALL)

   109 	$(mkinstalldirs) $(DESTDIR)$(htmldir)/html

   110 	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

   111 	  f="`echo $$p | sed -e 's|^.*/||'`"; \

   112 	  echo " $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/html/$$f"; \

   113 	  $(INSTALL_DATA) $$p $(DESTDIR)$(htmldir)/html/$$f; \

   114 	done

   115 

   116 uninstall-local:

   117 	@$(NORMAL_UNINSTALL)

   118 	for p in doc/html/*.{html,css,png,map,gif,tag} ; do \

   119 	  f="`echo $$p | sed -e 's|^.*/||'`"; \

   120 	  echo " rm -f $(DESTDIR)$(htmldir)/html/$$f"; \

   121 	  rm -f $(DESTDIR)$(htmldir)/html/$$f; \

   122 	done

   123 

   124 .PHONY: update-external-tags
lemon