Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
D
doxverilog
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Commits
Open sidebar
Elphel
doxverilog
Commits
77a40b4e
Commit
77a40b4e
authored
Jun 30, 2016
by
Mikhail Karpenko
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Modify README.md
parent
14eda352
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
75 additions
and
72 deletions
+75
-72
README.md
README.md
+3
-72
README_doxygen.md
README_doxygen.md
+72
-0
No files found.
README.md
View file @
77a40b4e
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, C#, PHP, Java, Python, IDL
(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
and to some extent D.
Doxygen can help you in three ways:
1.
It can generate an on-line documentation browser (in HTML) and/or an
off-line reference manual (in LaTeX) from a set of documented source files.
There is also support for generating output in RTF (MS-Word), PostScript,
hyperlinked PDF, compressed HTML, DocBook and Unix man pages.
The documentation is extracted directly from the sources, which makes
it much easier to keep the documentation consistent with the source code.
2.
You can configure doxygen to extract the code structure from undocumented
source files. This is very useful to quickly find your way in large
source distributions. Doxygen can also visualize the relations between
the various elements by means of include dependency graphs, inheritance
diagrams, and collaboration diagrams, which are all generated automatically.
3.
You can also use doxygen for creating normal documentation (as I did for
the doxygen user manual and doxygen web-site).
Download
---------
The latest binaries and source of Doxygen can be downloaded from:
*
http://www.doxygen.org/
Developers
---------
*
Build Status:
<a
href=
"https://travis-ci.org/doxygen/doxygen"
><img
src=
"https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"
/></a>
*
Coverity Scan Build Status:
<a
href=
"https://scan.coverity.com/projects/2860"
>
<img
alt=
"Coverity Scan Build Status"
src=
"https://scan.coverity.com/projects/2860/badge.svg"
/>
</a>
*
Doxygen's Doxygen Documentation:
<a
href=
"https://codedocs.xyz/doxygen/doxygen/"
><img
src=
"https://codedocs.xyz/doxygen/doxygen.svg"
/></a>
*
Install
*
Quick install see (./INSTALL)
*
else http://www.doxygen.org/manual/install.html
*
Project stats: https://www.openhub.net/p/doxygen
Issues, bugs, requests, ideas
----------------------------------
Use the bug tracker to report bugs:
*
current list:
*
[
Bugzilla
](
https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
)
*
Submit a new bug or feature request
*
[
Enter bug
](
https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen
)
Comms
----------------------------------
### Mailing Lists ###
There are three mailing lists:
*
doxygen-announce@lists.sourceforge.net - Announcement of new releases only
*
doxygen-users@lists.sourceforge.net - for doxygen users
*
doxygen-develop@lists.sourceforge.net - for doxygen developers
*
To subscribe follow the link to
*
http://sourceforge.net/projects/doxygen
Source Code
----------------------------------
In May 2013, Doxygen moved from
subversion to git hosted at github
*
https://github.com/doxygen/doxygen
Enjoy,
Dimitri van Heesch (dimitri at stack.nl)
#### doxverilog ####
The is a clone of doxverilog repository tested on Elphel projects. It will be kept in sync with the original repository on Bitbucket:
[
https://bitbucket.org/maddoxx/doxverilog.git
](
https://bitbucket.org/maddoxx/doxverilog.git
)
README_doxygen.md
0 → 100644
View file @
77a40b4e
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, C#, PHP, Java, Python, IDL
(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
and to some extent D.
Doxygen can help you in three ways:
1.
It can generate an on-line documentation browser (in HTML) and/or an
off-line reference manual (in LaTeX) from a set of documented source files.
There is also support for generating output in RTF (MS-Word), PostScript,
hyperlinked PDF, compressed HTML, DocBook and Unix man pages.
The documentation is extracted directly from the sources, which makes
it much easier to keep the documentation consistent with the source code.
2.
You can configure doxygen to extract the code structure from undocumented
source files. This is very useful to quickly find your way in large
source distributions. Doxygen can also visualize the relations between
the various elements by means of include dependency graphs, inheritance
diagrams, and collaboration diagrams, which are all generated automatically.
3.
You can also use doxygen for creating normal documentation (as I did for
the doxygen user manual and doxygen web-site).
Download
---------
The latest binaries and source of Doxygen can be downloaded from:
*
http://www.doxygen.org/
Developers
---------
*
Build Status:
<a
href=
"https://travis-ci.org/doxygen/doxygen"
><img
src=
"https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"
/></a>
*
Coverity Scan Build Status:
<a
href=
"https://scan.coverity.com/projects/2860"
>
<img
alt=
"Coverity Scan Build Status"
src=
"https://scan.coverity.com/projects/2860/badge.svg"
/>
</a>
*
Doxygen's Doxygen Documentation:
<a
href=
"https://codedocs.xyz/doxygen/doxygen/"
><img
src=
"https://codedocs.xyz/doxygen/doxygen.svg"
/></a>
*
Install
*
Quick install see (./INSTALL)
*
else http://www.doxygen.org/manual/install.html
*
Project stats: https://www.openhub.net/p/doxygen
Issues, bugs, requests, ideas
----------------------------------
Use the bug tracker to report bugs:
*
current list:
*
[
Bugzilla
](
https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
)
*
Submit a new bug or feature request
*
[
Enter bug
](
https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen
)
Comms
----------------------------------
### Mailing Lists ###
There are three mailing lists:
*
doxygen-announce@lists.sourceforge.net - Announcement of new releases only
*
doxygen-users@lists.sourceforge.net - for doxygen users
*
doxygen-develop@lists.sourceforge.net - for doxygen developers
*
To subscribe follow the link to
*
http://sourceforge.net/projects/doxygen
Source Code
----------------------------------
In May 2013, Doxygen moved from
subversion to git hosted at github
*
https://github.com/doxygen/doxygen
Enjoy,
Dimitri van Heesch (dimitri at stack.nl)
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment