dirac_doc_howto.txt
上传用户:xjjlds
上传日期:2015-12-05
资源大小:22823k
文件大小:2k
源码类别:

多媒体编程

开发平台:

Visual C++

  1. Dirac Documentation HOW-TO
  2. by Scott Robert Ladd (scott.ladd@coyotyegulch.com)
  3. The Dirac technical documentation comes in two forms:
  4. 1) Embedded API documentation that is extract via Doxygen to produce
  5.    external documentation in HTML and LATEX formats.
  6. 2) A description of the Dirac Algorithms, maintained as a LATEX file
  7.    that serves as the source code for PostScript, PDF, and HTML
  8.    documents.
  9.    
  10. This document describes how to build the Dirac documentation, and lsist
  11. the tools required for its creation.
  12. Producing API Documentation with Doxygen
  13. ----------------------------------------
  14. Doxygen (http://www.doxygen.org) is an industry-standard program for
  15. extracting documentation from specially-formatted source code. In
  16. concept, Doxygen is similar to Java's Javadoc utility. Doxygen uses
  17. the GraphViz (http://www.graphviz.org) package to produce professional
  18. class diagrams from an analysis of the source code.
  19. Use the following command to produce the documents with Doxygen:
  20.     # doxygen dirac_api.doxygen
  21.     
  22. The above command generates three directories filled with documentation
  23. in three formats: HTML, LATEX, and Unix man pages.
  24. The HTML can simply be copied to any appropriate directory on a web
  25. server for display.
  26. To generate a final PDF file from the LATEX source, simply execute a
  27. "make" command in the codec/doc/latex directory.
  28. Producing the Dirac Algorithm document
  29. --------------------------------------
  30. The source for Dirac Algorithm document is a LATEX
  31. (http://www.latex.org)
  32. [TODO]