0000254: Automatically hyperlinking module names in comment texts is sometimes inconvenient

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

Project

Category

View Status

Date Submitted

Last Update

0000254

OMNeT++

IDE / documentation generator

public

2011-02-22 23:33

2011-02-22 23:35

Reporter

andras

Assigned To

andras

Priority

normal

Severity

minor

Reproducibility

have not tried

Status

resolved

Resolution

fixed

Platform

OS Version

Product Version

4.1

Target Version

Fixed in Version

4.2b1

Summary

0000254: Automatically hyperlinking module names in comment texts is sometimes inconvenient

Description

Hyperlinking can be over-aggressive, e.g. in the phrases "IP address" or "TCP port" it links to the IP and TCP modules, which is not what the author wants. Escaping with backslash ("\IP address") is cumbersome, and e.g. in INET there are a lot of such "false positives", many of them unexpected, and it's impossible to escape them all. (Proof: browse old INET docu...)

There should be a possibility to turn off automatic hyperlinking, and instead explicitly denote which words need to be linked, e.g. with tilde: "the ~TCP module".

Tags

No tags attached.

Attached Files

Relationships

Notes
(0000390) andras (administrator) 2011-02-22 23:35	Added a checkbox in the Generate Documentation.. dialog to choose between auto-linking and tilde mode. [Tamas Borbely]

Issue History
Date Modified	Username	Field	Change
2011-02-22 23:33	andras	New Issue
2011-02-22 23:35	andras	Note Added: 0000390
2011-02-22 23:35	andras	Status	new => resolved
2011-02-22 23:35	andras	Fixed in Version	=> 4.2b1
2011-02-22 23:35	andras	Resolution	open => fixed
2011-02-22 23:35	andras	Assigned To	=> andras