Is source3/include/vfs.h the correct place for Doxygen comments on the vfs?

[Andreas Schneider]

On Friday 17 May 2013 18:41:40 Richard Sharpe wrote:
> Hi folks,

Hi Richard,

> Some have asked for doxygen comments on the VFS.
> 
> Is source3/include/vfs.h the correct place for that?

yes, I think so.

I don't know if you use vim but there is a plugin which helps you creating 
Doxygen documentation.

http://www.vim.org/scripts/script.php?script_id=987

my config:

" doxygen
let g:DoxygenToolkit_authorName="Andreas Schneider"
let g:DoxygenToolkit_licenseTag="GPL"
let g:DoxygenToolkit_undocTag="DOXIGEN_SKIP_BLOCK"
let g:DoxygenToolkit_briefTag_funcName = "no"
let g:DoxygenToolkit_commentType = "C"

let g:DoxygenToolkit_briefTag_pre = " @brief "
let g:DoxygenToolkit_briefTag_post = ""
let g:DoxygenToolkit_paramTag_pre = " @param[in]  "
let g:DoxygenToolkit_paramTag_post = " "
let g:DoxygenToolkit_returnTag = " @return "
let g:DoxygenToolkit_fileTag = " @file "
let g:DoxygenToolkit_authorTag = " @author "
let g:DoxygenToolkit_dateTag = " @date "
let g:DoxygenToolkit_blockTag = " @name "
let g:DoxygenToolkit_classTag = " @class "
let g:DoxygenToolkit_startCommentTag = "/**"
let g:DoxygenToolkit_startCommentBlock = "/*"
let g:DoxygenToolkit_interCommentTag = "*"
let g:DoxygenToolkit_endCommentTag = "*/"
let g:DoxygenToolkit_endCommentBlock = " */"

If you have any questions let me know. I've written the doxygen documentation 
for talloc, tevent and tdb.



	-- andreas

-- 
Andreas Schneider                   GPG-ID: F33E3FC6
Samba Team                             asn at samba.org
www.samba.org