Source File
comment.go
Belonging Package
go/doc
// Copyright 2009 The Go Authors. All rights reserved.// Use of this source code is governed by a BSD-style// license that can be found in the LICENSE file.package docimport ()// ToHTML converts comment text to formatted HTML.//// Deprecated: ToHTML cannot identify documentation links// in the doc comment, because they depend on knowing what// package the text came from, which is not included in this API.//// Given the *[doc.Package] p where text was found,// ToHTML(w, text, nil) can be replaced by://// w.Write(p.HTML(text))//// which is in turn shorthand for://// w.Write(p.Printer().HTML(p.Parser().Parse(text)))//// If words may be non-nil, the longer replacement is://// parser := p.Parser()// parser.Words = words// w.Write(p.Printer().HTML(parser.Parse(d)))func ( io.Writer, string, map[string]string) {:= new(Package).Parser().Words =:= .Parse():= new(comment.Printer).Write(.HTML())}// ToText converts comment text to formatted text.//// Deprecated: ToText cannot identify documentation links// in the doc comment, because they depend on knowing what// package the text came from, which is not included in this API.//// Given the *[doc.Package] p where text was found,// ToText(w, text, "", "\t", 80) can be replaced by://// w.Write(p.Text(text))//// In the general case, ToText(w, text, prefix, codePrefix, width)// can be replaced by://// d := p.Parser().Parse(text)// pr := p.Printer()// pr.TextPrefix = prefix// pr.TextCodePrefix = codePrefix// pr.TextWidth = width// w.Write(pr.Text(d))//// See the documentation for [Package.Text] and [comment.Printer.Text]// for more details.func ( io.Writer, string, , string, int) {:= new(Package).Parser().Parse():= &comment.Printer{TextPrefix: ,TextCodePrefix: ,TextWidth: ,}.Write(.Text())}
![]() |
The pages are generated with Golds v0.7.9-preview. (GOOS=linux GOARCH=amd64) Golds is a Go 101 project developed by Tapir Liu. PR and bug reports are welcome and can be submitted to the issue list. Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds. |