Jump to content

Python and Doxygen

- - - - -

This topic has been archived. This means that you cannot reply to this topic.
2 replies to this topic

#1
denarced

denarced

    Programmer

  • Members
  • PipPipPipPip
  • 182 posts
Hi,

I have a few classes of python and growing in my little project.
I used to inherit classes which Doxygen noticed and acted correctly but then I changed it.
Now I'm using the Decorator design pattern, meaning that I merely create an instance of the formerly inherited class and then extend or modify or what ever (code example @ bottom).
Doxygen does not understand this.
Anyone know a solution ?

class Super(object):
    def __init__(self):
        pass

class Decorated(object):
    def __init__(self):
        self.__super = Super()

    def __getattr__(self, attr):
        return getattr(self.__super, attr)


#2
Alexander

Alexander

    It's Science!

  • Moderators
  • 4,124 posts
I am unaware if the Python module for Doxygen can do too much, it was not very much meant for that. Another choice of documenter which is official for Python is Sphinx:
Overview — Sphinx v1.0.5 documentation
Be sure to read the updated FAQ! || Health is achieved through the same 10,000 steps.
If a suggested code/method fails, informing us is less important than telling us why or what errors occurred.

#3
denarced

denarced

    Programmer

  • Members
  • PipPipPipPip
  • 182 posts

Alexander said:

I am unaware if the Python module for Doxygen can do too much, it was not very much meant for that. Another choice of documenter which is official for Python is Sphinx:
Overview — Sphinx v1.0.5 documentation

I'll have to checkout sphinx .. thanks