Adds ability to ignore parse exception console messages

[dambrosio]

Allows a user to specify the doxyfile_ignore_parse_exceptions=True configuration value in the Sphinx conf.py file to prevent doxylink tag parsing from printing messages to console.

I.e.

Skipping function transform::invR(transform_pb2.Rotation2f a). Error reported from parser was: Expected ')', found '.'  (at char 14), (line:1, col:15)

These parsing messages can overwhelm the console and mask users from seeing valuable error or warning messages provided by Sphinx

[JasperCraeghs]

Thanks for this contribution. Instead of a boolean, we could support a list of regular expressions instead, for added granularity. What do you think?

This project has received contributions that we recently merged to the master branch but have not yet been released. These contributions will likely get rid of many of the parser warnings tnat you encounter. I will try to reach out to the owner of this repository again to make a release.

[JasperCraeghs]

Suggested change

	'_'.join([DOXYLINK_KEY,'ignore_parse_exceptions'])
	'_'.join([DOXYLINK_KEY, 'ignore_parse_exceptions'])

[dambrosio]

That is my bad. Do we have a default linter/formatter for Python in this repo, to minimize these lint issues?

[JasperCraeghs]

Suggested change

	report_info(app.env,"Ignoring parsing exceptions")
	report_info(app.env, "Ignoring parsing exceptions")

[JasperCraeghs]

FYI We have released version 1.12.4 this evening.

I triggered the unit tests in CI and some of them require an update. If you want any help, let me know. 🙂

[dambrosio]

FYI We have released version 1.12.4 this evening.

I triggered the unit tests in CI and some of them require an update. If you want any help, let me know. 🙂

I can test this out to see if it fixes some of the parse exceptions in our code base.

[dambrosio]

Thanks for this contribution. Instead of a boolean, we could support a list of regular expressions instead, for added granularity. What do you think?

I would be down to change this behavior. Are you thinking a single regex or multiple regexs? Would the idea be to match specific text inside of the ParseException error message?

ie.

Skipping function company::DEFINE_string(logs_directory, "", "Path to the directory."). Error reported from parser was: Expected ')', found ','  (at char 15), (line:1, col:16)

So we could add a regex that would be something like company::DEFINE to only match specific member_kind, member_symbol or arglist values?

[dambrosio]

FYI We have released version 1.12.4 this evening.
I triggered the unit tests in CI and some of them require an update. If you want any help, let me know. 🙂

I can test this out to see if it fixes some of the parse exceptions in our code base.

I still see parse exceptions in our code base. I think some are probably due to our usage of gflags as well as selectively including specific source for documentation. In either case, I still think having a mechanism to disable these prints would be helpful from our end.

[dambrosio]

@JasperCraeghs I updated with the regex approach. Here are my local repo test results:

Default for doxylink_parse_exception_ignore_regex_list

Skipping function company::DEFINE_bool(show, false, "Enable visualization"). Error reported from parser was: Expected ')', found ','  (at char 12), (line:1, col:13)
...
Skipping function company::anonymous_namespace{builder.cc}::kRange3D(8.f, 8.f, 3.f). Error reported from parser was: Expected ')', found '.'  (at char 2), (line:1, col:3)
...
Skipping function transform::getAngle(transform_pb2.Rotation2f rot). Error reported from parser was: Expected ')', found '.'  (at char 14), (line:1, col:15)
...

With the following doxylink_parse_exception_ignore_regex_list = [r".*DEFINE.*", r".*anonymous_namespace.*"]

Ignoring parsing exceptions using `re.compile('.*DEFINE.*|.*anonymous_namespace.*')`
...
Skipping function transform::getAngle(transform_pb2.Rotation2f rot). Error reported from parser was: Expected ')', found '.'  (at char 14), (line:1, col:15)
...