pkgsrc/devel/doxymacs/MESSAGE
dsainty 901a96ea40 The purpose of the Doxymacs project is to create a LISP package that will make
using Doxygen from within {X}Emacs easier.

Doxymacs has the following features:

  * ability to look up documentation for symbols from {X}Emacs in the browser
    of your choice.

  * easily insert Doxygen style comments into source.

  * optionally use an "external" (i.e. written in C) XML parser to speed up
    building the completion list.

  * fontify Doxygen keywords.
2006-11-01 07:02:31 +00:00

27 lines
883 B
Text

===========================================================================
$NetBSD: MESSAGE,v 1.1.1.1 2006/11/01 07:02:31 dsainty Exp $
To use Doxymacs, put:
(require 'doxymacs)
... in your .emacs file.
Invoke 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 file.
If you want Doxygen keywords fontified use M-x doxymacs-font-lock. To do it
automatically, add the following to your .emacs file:
(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.
===========================================================================