Doxymacs is Doxygen + {X}Emacs.
The purpose of the doxymacs project is to create a LISP package that will make using Doxygen from within {X}Emacs easier.
Version 1.8.0, released 2007-06-10, has the following features:
Please direct any bug reports or feature requests to the appropriate forum on Doxymacs' SourceForge page.
$ ./configure $ make $ make installBe sure to put
${datadir}/share/${EMACS}/site-lisp
in your load-path
in your .emacs
file, or wherever you configured the .elc files to end up.
!! File error (("Cannot open load file" "url"))(or something similar) when you do
make
,
then set the variable EMACSLOADPATH
:
$ EMACSLOADPATH=... makewhere
...
is a colon separated list of directories
to seach for packages.
EMACS
:
$ EMACS=xemacs makeIf you want to avoid byte-compiling altogether:
$ make ELCFILES= $ make install ELCFILES=For a complete list of configuration options:
$ ./configure --helpIf you do not want to run or cannot run
configure
then pre-baked .el
files are available in the
no-autoconf/
directory; simply
copy these to somewhere in your load-path
.
doxymacs-doxygen-root
and
doxymacs-doxygen-tags
. You can customise these
via the customisation menu Programming | Tools | Doxymacs.
doxymacs-doxygen-style
. The
default is "JavaDoc". See the
Doxygen manual for examples of the three available styles
(JavaDoc, Qt and C++).
doxymacs-use-external-xml-parser
to non-nil (can
be done via the customisation menu).
(require 'doxymacs)
in your .emacs
file.
doxymacs-mode
with M-x
doxymacs-mode
. To have doxymacs-mode
automatically come up whenever you visit a C/C++ file, put
(add-hook 'c-mode-common-hook'doxymacs-mode)
in
your .emacs
.
M-x
doxymacs-font-lock
. To do it automatically, add
the following to your .emacs
:
(defun my-doxymacs-font-lock-hook () (if (or (eq major-mode 'c-mode) (eq major-mode 'c++-mode)) (doxymacs-font-lock))) (add-hook 'font-lock-mode-hook 'my-doxymacs-font-lock-hook)This will add the Doxygen keywords to c-mode and c++-mode only.
C-c d ?
will look up documentation for the symbol
under the point.
C-c d r
will rescan your Doxygen tags file.
C-c d f
will insert a Doxygen comment for the
next function.
C-c d i
will insert a Doxygen comment for the
current file.
C-c d ;
will insert a Doxygen comment for a
member variable on the current line (like M-;
).
C-c d m
will insert a blank multi-line Doxygen
comment.
C-c d s
will insert a blank single-line Doxygen
comment.
C-c d @
will insert grouping comments around the
current region.