On 2013-12-30 20:08, Walter Bright wrote:
This will create many unwanted links, in three scenarios:
I don't think so, see below.
1. In the description for S, there should not be hyperlinks to S. These would be annoying - when you click on them, nothing will happen.
The compiler knows which symbol it currently generating documentation for, just exclude that.
2. Using the word S as a word, not in reference to symbol S, would generate a hyperlink which would not make sense.
I've have seen that happened a couple of times with documentation generators that support it, it has never bother me. As Sönke has said, you can solve that by appending an underscore and the compiler would not create a link of the symbol.
3. If there are multiple symbols S, hyperlinks to the wrong one would be created. This is worse than useless.
Most of the times there are not multiple symbols with the same name, the language make sure of that. Although there will be a problem with function overloading.
In my adding of such hyperlinks, 1..3 happen regularly, this is not a "may" happen. It's a "will" happen, a lot.
I don't agree, I don't think it's a problem. It's far better than having to add macros everywhere instead.
-- /Jacob Carlborg
