Function: semantic-tag-docstring

semantic-tag-docstring is a byte-compiled function defined in tag.el.gz.

Signature

(semantic-tag-docstring TAG &optional BUFFER)

Documentation

Return the documentation of TAG.

That is the value defined by the :documentation attribute. Optional argument BUFFER indicates where to get the text from. If not provided, then only the POSITION can be provided.

If you want to get documentation for languages that do not store the documentation string in the tag itself, use semantic-documentation-for-tag instead.

Source Code

;; Defined in /usr/src/emacs/lisp/cedet/semantic/tag.el.gz
(defun semantic-tag-docstring (tag &optional buffer)
  "Return the documentation of TAG.
That is the value defined by the `:documentation' attribute.
Optional argument BUFFER indicates where to get the text from.
If not provided, then only the POSITION can be provided.

If you want to get documentation for languages that do not store
the documentation string in the tag itself, use
`semantic-documentation-for-tag' instead."
  (let ((p (semantic-tag-get-attribute tag :documentation)))
    (cond
     ((stringp p) p) ;; it is the doc string.

     ((semantic-lex-token-with-text-p p)
      (semantic-lex-token-text p))

     ((and (semantic-lex-token-without-text-p p)
	   buffer)
      (with-current-buffer buffer
	(semantic-lex-token-text (car (semantic-lex p (1+ p))))))

     (t nil))))