About Document

Directory document contains five different kinds of documents.

• doxygen:

  source-file-related documents, which are generated by Doxygen.

• description:

  module-related documents, which are written manually.

• brief:

  branch-related documents, which are written manually.

• conclusion:

  phase-related documents, which are written manually.

• performance:

  evaluation-related documents, which are generated by regression environments.

Doxygen

Directory doxygen contains source-file-related documents, which are generated by Doxygen:

“Doxygen is the de facto standard tool for generating documentation from annotated C++ sources,

but it also supports other popular programming languages such as C, Objective-C …”

Please refer to https://www.doxygen.nl/index.html for more information.

Description

Directory description contains module-related documents, which may contain contents like

• introduction and background

• algorithm and workflow

• functions & their call relationship (sure, we can refer to Doxygen documents for more detailed information)

• macro definitions, types, and classes & their members (sure, we can refer to Doxygen documents for more detailed information)

• performance and comparison

• TODOs

Brief

Directory brief contains branch-related documents, which may contain contents like

• introduction and background

• motivation and target

• algorithm and workflow

• delta of commits

• performance and comparison

• TODOs

Conclusion

Directory conclusion contains phase-related documents, which may contain contents like

• target and date

• updates in each directory

• status of each branch

• achievements and insufficiency

• TODOs

Performance

Directory performance contains evaluation-related documents, which may contain contents like

• run time

• accuracy, SNR, PSNR

And those contents should be easily produced and reproduced by regression environments.

Existing Environments

doxygen/xkmsc

• Function

  1. generate source file related documents with Doxygen

• Pre-Request

  item	my version
  Doxygen	1.8.17
  Graphviz	2006.11.19

• Content

  item	description	postscript
  doxygen.sh	generating script
  doxygen.cfg	configuration file
  html	directory for html files	generated by command ./doxygen.sh
  latex	directory for latex files	generated by command ./doxygen.sh

• Usage

  In the WSL environment, change the directory to document/doxygen/xkmsc,

  then you can

  1. complete the above functions with

     ./doxygen.sh
     

     then you will get

     
     
     

     (main entry for HTML files is document/doxygen/xkmsc/html/index.html)

     

     (main entry for LaTeX files is document/doxygen/xkmsc/latex/refman.pdf)