Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type CommentPart ¶
type CommentPart struct {
Line int // Comment part location inside phpdoc comment
Name string // e.g. "param" for "* @param something bla-bla-bla"
Params []string // {"something", "bla-bla-bla"} in example above
ParamsText string // "something bla-bla-bla" in example above
}
func Parse ¶
func Parse(doc string) (res []CommentPart)
Parse returns parsed doc comment with interesting parts (ones that start "* @")
func (*CommentPart) ContainsParam ¶
func (part *CommentPart) ContainsParam(name string) bool
ContainsParam reports whether comment part contains param of specified name.
Source Files
Click to show internal directories.
Click to hide internal directories.