How to make doxygen ignore the first line of a Python script?

Question

I have a docstring in the beginning of a Python script that Doxygen parses perfectly. However, if I add #!/usr/bin/env python in the beginning of the file (to make the script executable), the entire docstring is not recognized by Doxygen.

So, how can I make Doxygen ignore this first line?

Example of a working docstring:

"""@package HelloWorld
This is a docstring and it's recognized by doxygen."""

Example of a non-working docstring:

#!/usr/bin/env python
"""@package HelloWorld
This is a docstring and it's not recognized by doxygen because of the first line."""

Thanks!

This is a more specific question than that one I think, even though they are related. — Oriol Nieto
– Oriol Nieto, Commented Apr 11, 2013 at 15:36

Oriol Nieto · Accepted Answer · 2013-04-12 14:45:53Z

1

Ok, I found it: I need to use a parser first. I tried doxypy and it works really well. You only have to make the following changes in your doxy_conf file:

FILTER_SOURCE_FILES = YES
INPUT_FILTER = "python path/to/doxypy.py"

answered Apr 12, 2013 at 14:45

Oriol Nieto

5,6697 gold badges34 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to make doxygen ignore the first line of a Python script?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related