[Doxygen-users] Documenting django models

[Lars S. <st...@te...>]

Is anyone using doxygen to document the Python based Django
web framework models?

I use doxypy together with doxygen to document python code,
and it works very well for pure python.

For django I have a cosmetic issue that I would appreciate
some help with:

A sample Django model:

class View(models.Model):
    """
    Available ClearCase views.
    \param name    ClearCase view name.
    \param branch  Corresponding ClearCase Branch.
    """
    name   = models.CharField(max_length=40)
    branch = models.ForeignKey(Branch)

I want to document the attributes, i.e. 'name', 'user', etc.
in the class documentation part, as shown above, rather than
using comments above the attribute definition, as shown here:

class View(models.Model):
    """
    Available ClearCase views.
    """
    ## ClearCase view name.
    name   = models.CharField(max_length=40)
    ## Corresponding ClearCase Branch.
    branch = models.ForeignKey(Branch)

In the latter case, the doxygen generated documentation looks
great, but I really need to use the first case above, but with
something other than the "\param" directive, something that tells
doxygen that the corresponding attribute is in fact documented.
Reason being that some of the django models are big and is easier
to read when using the first form above (told you it's a cosmetic
issue:)

/Lars Stavholm