[Doxygen-users] snippet woes

[Mark <dox...@er...>]

I am having problems with the snippet command.

In one of my source files, glloader.c I have

/**
 * @example glloader.c
 * This is an example of using the low-level ktxTexture API to create and load
 * an OpenGL texture. It is a fragment of the code used by
 * @ref ktxTexture_GLUpload which underpins the @c ktxLoadTexture* functions.
 *
 * @code
 * #include <ktx.h>
 * @endcode
 *
 * This structure is used to pass to a callback function data that is uniform
 * across all images.
 * @snippet this cbdata
 *
 * One of these callbacks, selected by @ref ktxTexture_GLUpload based on the
 * dimensionality and arrayness of the texture, is called from
 * @ref ktxTexture_IterateLevelFaces to upload the texture data to OpenGL.
 * @snippet this imageCallbacks
 *
 * This function creates the GL texture object and sets up the callbacks to
 * load the image data into it.
 * @snippet this loadGLTexture
 */

When my block ids are marked as special comments (e.g. /**, /*!) Doxygen inserts the block ids into the documentation for the function immediately following the block id as well as using them as block ids. I solved this by changing the block id comments into regular comments. I don’t know if this a doxygen bug or a documentation problem. The doc gives only 1 example of a block id and it uses a special comment “//!”.

Another issue is that following the last snippet, Doxygen is including the entire glloader.c file in the “glloader.c” example that it generates. If I wanted to included the whole file I wouldn’t be using snippets. How can I stop Doxygen doing this?

Regards

    -Mark