Create README.md


Introduction
============
 Doxverilog  is a nativ verilog parser (Verilog 2005) for Doxygen. You can now
 documentate your verilog project  similar to VHDL in Doxygen. 

========== additional tools for compiling the sources =========

  Name			version		                        URL
  ----			---------------		                ---
  * bison		2.1 or higher		         http://www.gnu.org/software/bison/bison.html
  * flex		2.5.35 or higher                    http://flex.sourceforge.net
  	 
==================  LINUX  =====================================

    open a shell in the doxygen-1.8.5 directory

   - configure doxygen
     sh configure
  
   - compile  the source files
     make all

==================  WINDOWS =====================================	 
	
	Open doxygen-1.8.5\winbuild\Doxygen.vcproj with Visual C++ 2008 Express Edition

=================================================================

   If the compilation is successful create a doxygen configuration file with  # doxygen -s -g verilog.cfg
   In the configuration file you should see the option OPTIMIZE_OUTPUT_VERILOG. 
   The file patterns for the Verilog parser  are *.v and *.V

  For further information and how doxygen works see http://www.stack.nl/~dimitri/doxygen/manual.html

Example for a Verilog  configuration file
=========================================

  PROJECT_NAME         = Project name
  OUTPUT_DIRECTORY     = Project directory
  GENERATE_HTML        = YES
  INPUT                =   path to your verilog files
  FILE_PATTERNS          = *.v
  OPTIMIZE_OUTPUT_VERILOG = YES
  HIDE_PORT              = yes
  EXTENSION_MAPPING      = h=v
  QUIET                = YES
  INHERIT_DOCS         = YES
  EXTRACT_ALL          = YES
  HIDE_SCOPE_NAMES     = YE
  SOURCE_BROWSER       = YES
  ENABLE_PREPROCESSING   = YES
  MACRO_EXPANSION        = yes
  SEARCH_INCLUDES        = yes
 
 Documentation in Verilog
 =========================================

 Verilog comments start  with "//". 
 Doxygen extracts comments that starts with a "//%" prefix.
 Comments can be made before or after each item.
 
 //% a one line comment
 
 //% a
 //% multi line
 //% comment

 or 
 
 /*! a
  *  multi line
  *   comment
  */

 example for comments

//% @file xor2.v
//% @brief xor with two inputs

//% Xor Module brief description
//% Detailed description of this module 

module XOR2 ( OUT, I0, I1 );
	input I0; //% first input
	input I1; //% second input
	
	//% output
	output OUT;

	assign OUT = I0 ^ I1;
endmodule