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
f9aadfdc
Commit
f9aadfdc
authored
May 25, 2013
by
Dimitri van Heesch
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added Markdown formatted README for GitHub
parent
c77aea4c
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
68 additions
and
29 deletions
+68
-29
README
README
+0
-29
README.md
README.md
+68
-0
No files found.
README
deleted
100644 → 0
View file @
c77aea4c
DOXYGEN Version 1.8.4
Please read INSTALL for compilation instructions.
The latest version of doxygen can be obtained from:
http://www.doxygen.org/
There are three mailing lists:
doxygen-users@lists.sourceforge.net For doxygen users
doxygen-develop@lists.sourceforge.net For doxygen developers
doxygen-announce@lists.sourceforge.net Announcement of new releases only
please follow the link in
http://sourceforge.net/projects/doxygen
to subscribe to the lists or to visit the archives.
Use the bug tracker to report bugs:
https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen
Before reporting a bug, please check that it has not already been reported.
Also, please use the bug tracker for reporting bugs rather than the help
forum.
Enjoy,
Dimitri van Heesch (dimitri@stack.nl) (19 May 2013)
README.md
0 → 100644
View file @
f9aadfdc
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
*
!
[
Alt text
](
https://secure.travis-ci.org/doxygen/doxygen.png?branch=master
)
*
https://travis-ci.org/doxygen/doxygen
### Install ###
*
Quick install see (./INSTALL)
*
else http://www.doxygen.org/manual/install.html
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@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