[go-nuts] How to link to a function when documenting the code.

Christoph Hack

at May 4, 2013 at 11:26 am

The godoc tool currently does not support any kind of markup. Writing good
documentation is already difficult enough without custom markup languages.

Am Samstag, 4. Mai 2013 12:43:00 UTC+2 schrieb Nguyên Nguyễn Văn Cao:

I mean a click able link on the comment. For example, the comment for Foo
function:
Foo do something that similar with Bar.

How can I make "Bar" click able? I don't think we can use HTML in the
comment, so an change to make it auto-link just like what we does with the
agrs list?

--
You received this message because you are subscribed to the Google Groups "golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

reply | permalink

Hotei

at May 4, 2013 at 1:46 pm

⇧

You can create an example for any function. Don't know if that's
sufficient for your issue but it's relatively easy and ends up in the godoc
output without cluttering your main code.

On Saturday, May 4, 2013 6:43:00 AM UTC-4, Nguyên Nguyễn Văn Cao wrote:

I mean a click able link on the comment. For example, the comment for Foo
function:
Foo do something that similar with Bar.

How can I make "Bar" click able? I don't think we can use HTML in the
comment, so an change to make it auto-link just like what we does with the
agrs list?

--
You received this message because you are subscribed to the Google Groups "golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

reply | permalink

Andrew Gerrand

at May 5, 2013 at 7:59 pm

⇧

Here's a feature request (by me) for turning names like "package foo" in
documentation to links to "/pkg/foo/", should it exist.

https://code.google.com/p/go/issues/detail?id=4953

The same could be done for "function Bar", "method Bar.Quux", "type Boing",
etc.

Andrew

--
You received this message because you are subscribed to the Google Groups "golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

reply | permalink

Nguyên Nguyễn Văn Cao

at May 9, 2013 at 2:20 am

⇧

How do you think about link them to godoc.org?

Vào 02:58:43 UTC+7 Thứ hai, ngày 06 tháng năm năm 2013, Andrew Gerrand đã
viết:

Here's a feature request (by me) for turning names like "package foo" in
documentation to links to "/pkg/foo/", should it exist.

https://code.google.com/p/go/issues/detail?id=4953

The same could be done for "function Bar", "method Bar.Quux", "type
Boing", etc.

Andrew

--
You received this message because you are subscribed to the Google Groups "golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.

reply | permalink

group	golang-nuts @
categories	go
posted	May 4, '13 at 10:43a
active	May 9, '13 at 2:20a
posts	5
users	4
website	golang.org

responses	expanded	Hotkey: s
font	variable	Hotkey: f
user style	avatars	Hotkey: a

[go-nuts] How to link to a function when documenting the code.

Search Discussions

Related Discussions

4 users in discussion