Doxymacs 中文

Doxymacs 就是 + {X}Emacs.

doxymacs项目的用途是更容易的在{X}Emacs中创建在Doxygen中使用的LISP包。

, 2007-06-10释放, 具备下列特点:

•  有在你选择的浏览器上 的能力.
•  在源代码中.
• 可选择性地使用“external”(即用C语言编写)XML解析器加快完成清单。
  
• .

Please direct any bug reports or feature requests to the appropriate forum on page.

Requirements（必要条件）

Doxymacs 取决于下列包:

• version 2.6.13 或者更高的 .

开始前，请确认他们已经被正确第配置并安装了。

Installation（安装）

• 用下列配置脚本配置和构建doxymacs:

  $ ./configure
  $ make
  $ make install
  	

  务必在你的.emacs文件中的你的load-path种加入${datadir}/share/${EMACS}/site-lisp, 或者配置 .elc 文件.
  
  注意 当你make的时候如果你遇到:

  !! File error (("Cannot open load file" "url"))
  	

  (or 其他什么类似的), 那么请设置变量 EMACSLOADPATH:

  $ EMACSLOADPATH=... make
          

  ...是用冒号分隔的目录列表的搜索软件包。	
  

  
  To byte compile with XEmacs, set the variable EMACS:

  $ EMACS=xemacs make
          

  If you want to avoid byte-compiling altogether:

  $ make ELCFILES=
  $ make install ELCFILES=
  	

  For a complete list of configuration options:

  $ ./configure --help
          

  如果你不想或不能运行configure，那么 在no-autoconf/中预先baked有效的 .el文件; 简单的copy这些文件到你的任意位置上的load-path中.
  
  
• 自定义变量 doxymacs-doxygen-root 和 doxymacs-doxygen-tags. 你能定义他们通过定制化程序菜单| Tools | Doxymacs.
• (可选) 自定义doxymacs-doxygen-style. 默认值是 "JavaDoc". 看 中这三个变量的例子(JavaDoc, Qt and C++).
• 使用额外的 XML 解析器, 设置doxymacs-use-external-xml-parser 为 non-nil (可通过定制化菜单设置).
• 在你的.emacs文件中加入(require 'doxymacs) .
• 调用doxymacs-mode 用 M-x doxymacs-mode. doxymacs-mode 自动地激活只要你在浏览一个C/C++ 文件, 请在.emacs文件中加入(add-hook 'c-mode-common-hook'doxymacs-mode).
• 如果你想使 Doxygen 关键字高亮，请用M-x doxymacs-font-lock. 在.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)
  	

  仅在c-mode 和 c++-mode中添加Doxygen 关键字.
• 默认绑定的按键（转载：）:
  • C-c d ? 从符号表中查找当前光标所在内容的文档（需要指定doxymacs-doxygen-dirs）
    
    
  • C-c d r 重新扫描 Doxygen 的 tags 文件（需要指定doxymacs-doxygen-dirs）
    
    
  • C-c d f 为所在位置之后的那个函数插入注释（注意是在当前光标处插入，最好在函数上方的空行处使用，插入前先对好齐）      
    /**
     *
     *
     * @param widget
     * @param event
     * @param data
     *
     * @return
     */
    
    
  • C-c d i 为当前文件插入注释（内容包括文件名、作者、日期和简介）
/**
 * @file   main.c
 * @author XXXXX
 * @date   Sat Jan  2 20:25:23 2010
 *
 * @brief 
 *
 *
 */


  • C-c d ; 为当前行的成员变量插入注释（类似M-;，但是格式不同）
    /**<  */
    M-;的注释就是常用的 /*  */
    
    
  • C-c d m 插入空白的多行注释，这个就在单纯是想要注释的时候用了
    /**
     *
     *
     */
    
    
  • C-c d s 插入空白的单行注释.
    ///
    
    
  • C-c d @ 插入分组注释。所谓分组注释就是将某个范围内的代码看作一组，生成文档时会单独归在一个组下。使用时要先选中想分组的那部分代码
    //@{//@}
    

Doxymacs 在下列情况下被测试过了:

• GNU Emacs 20.7.1, 21.1.1, 21.2.1, 21.3, 21.4.1.
• XEmacs 21.1 (patch 14), XEmacs 21.4 (patch 4, 5, 6, 17).
• Up to doxygen version 1.4.4

如果你在其他版本的{X}Emacs 和 doxygen状态下成功或者失败, 请让作者知道.

Links

• Go here to request help, submit a patch, or ask for a feature.
• Download it now.
• For bleeding edge people and developers.