Modify

Opened 9 years ago

Last modified 7 months ago

#1882 assigned enhancement

TracLinks in doxygen-comments?

Reported by: eckert@… Owned by: Committo-Ergo-Sum
Priority: normal Component: DoxygenPlugin
Severity: normal Keywords:
Cc: Trac Release: 0.10

Description

It would be very nice, if TracLinks from the doxygen-output is parsed. eg:

/**
  * This is a simple function. ([wiki:function/simplefunction details])
  * 
  * @param string input
  * @return string output
  * .........
  */

Attachments (0)

Change History (6)

comment:1 Changed 9 years ago by Blackhex

  • Owner changed from Blackhex to cboos

comment:2 Changed 7 months ago by rjollos

  • Owner changed from cboos to Committo-Ergo-Sum
  • Status changed from new to assigned

comment:3 Changed 7 months ago by rjollos

I'm not sure there is a simple way to handle this. There's a function in trac.wiki.formatter for formatting a link,

>> print(extract_link(env, context, '#100'))
<a class="missing ticket">#100</a>

However, you'll need to parse the text to be formatted from the Doxygen markup, for which you might need to write some regular expression. You probably want to look at formatter.py and parser.py.

comment:4 Changed 7 months ago by Committo-Ergo-Sum

Thanks for your suggestion. r15413 implements a minimal version of #1882 with some restrictions, see the log message. May be it is possible to avoid them, but presently it seems costly.

comment:5 Changed 7 months ago by rjollos

It would be good if you ran a PEP8 style checker. There are a number of minor issues in the codebase. I'll fix some of them if I find time.

comment:6 Changed 7 months ago by rjollos

In 15427:

0.7.2: Pass arguments to logger rather than interpolating string

This change conforms to PEP8.

Refs #1882.

Add Comment

Modify Ticket

Action
as assigned The owner will remain Committo-Ergo-Sum.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.