Changes: Quickfix and doxygen

Revision as of 06:39, 13 July 2012

Tip 1617 Printable Monobook Previous Next

created 2009 · complexity basic · author Gdw2 · version 7.0

I often use :make to build my C++ project and then go through the compile errors and fix them. :help quickfix

This simple tip shows how you can use :make to use Quickfix with doxygen.

From the shell command line, generate a default config file:

$doxygen -g

From within Vim do the following:

:set makeprg=doxygen
:make Doxyfile

Quickfix will then allow you to go through your doxygen errors as you would through gcc errors.

@@ Line 1: / Line 1: @@
+{{TipNew
-I often use :make to build my c++ project and then go through the compile errors and fix them using [http://www.vim.org/htmldoc/quickfix.html QuickFix].  This simple tip shows how you can use :make to use QuickFix with doxygen.
+|id=1617
+|previous=1616
+|next=1618
+|created=2009
+|complexity=basic
+|author=Gdw2
+|version=7.0
+|subpage=/200902
+|category1=
+|category2=
+}}
+I often use <code>:make</code> to build my C++ project and then go through the compile errors and fix them. {{help|quickfix}}
+This simple tip shows how you can use <code>:make</code> to use Quickfix with [http://www.stack.nl/~dimitri/doxygen/ doxygen].
-From the commandline, generate an error file:
+From the shell command line, generate a default config file:
 <pre>
-$doxygen -g && doxygen Doxyfile 2>errors.txt
+$doxygen -g
 </pre>
+From within Vim do the following:
-The above command generates a generic doxygen configuration file and runs doxygen storing errors/warnings in errors.txt.  (It also generates the documentation in the same folder).
-From within vim do the following:
 <pre>
-:set makeprg=cat
+:set makeprg=doxygen
-:make errors.txt
+:make Doxyfile
 </pre>
-Quickfix will then allow you to go through your doxygen errors as you would through gcc errors!
+Quickfix will then allow you to go through your doxygen errors as you would through gcc errors.
+==Comments==
-I'm sure there's a much more glamorous way to do this.