Menu

#54 Explicit @link doesn't work with urls

open
nobody
None
5
2013-10-30
2013-10-30
No

While making a documentation, I wrote in comment { See @link(http://pasdoc.sipsolutions.net/LinkTag this link) for more details } and the result in HTML generated document was "See UNKNOWN for more details".

I would like to suggest the possibility to make explicit links using @link. =)

Discussion

  • Marcos Rocha

    Marcos Rocha - 2013-10-30

    A requisite: External links should be shown in a new page with target="_blank".

     
  • Michalis Kamburelis

    100% agree to the idea that @link should also support URLs. @link should detect URLs, and then just use them (instead of trying to resolve them as Pascal identifier).

    A requisite: External links should be shown in a new page with target="_blank".

    I have to say I very disagree with this. I do not like pages that open external links automatically in new window/tab. Usually I know much better whether I want to open the link in new window/tab (then I ctrl+click it), or make it replace the current window/tab. There are some exceptions to this, but an API documentation doesn't quality IMHO. Also I don't think any other documentation generator adds target="_blank" for external links (at least Doxygen, I just checked).

    Moreover, we already can make external links from documentation (just write the URL, we'll turn it into link automatically). And they do not open in new window/tab.

     
  • Marcos Rocha

    Marcos Rocha - 2013-10-30

    Ok, I simply forgot the Ctrl+Click feature. To be more precise, I use to click with the middle mouse button. Anyway, if nobody manifest himself I can take this for me.

     

Log in to post a comment.

Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.