Class Comments

Summary

A linked list of comment blocks. Each comment block represents a "paragraph" of comments. Also, comments for the same entity that have been collected from different lexical sites reside in separate blocks on this chain.

Superclasses:
Object

Package:
UniDoc
File:
UniForm.icn
Methods:
add, append, get, getFirstSentence, newBlock, size

Methods inherited from Object:
Type, className, clone, equals, fieldNames, genMethods, getField, get_class, get_class_name, get_id, hasField, hasMethod, hash_code, instanceOf, invoke, is_instance, setField, to_string

Fields:
head, tail

Source code.

Details
Constructor

Comments(head, tail)

Methods:

add(newComment)

Add a comment to the current comment block.

append(newComments)

Append another list of comments to this list.

get()

Generates the chain of comment blocks. Fails if no comment blocks available.

getFirstSentence()

Produce the first "sentence" of this sequence of comments. Later, the definition of "sentence" will be improved.

newBlock()

Start a new comment block

size()

How many comments are there?

Fields:
head
tail
This page produced by UniDoc on 2021/04/15 @ 23:59:53.