CommentBlock

Class CommentBlock

Summary

A paragraph's worth of comments.

Superclasses:: Object
Package:: UniDoc
File:: UniForm.icn

Methods:

firstNonBlank, get, getFirstSentence, isLegacy, put, 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:

comments, legacy, nextblock

Source code.

Details

Constructor

CommentBlock(legacy, comments, nextblock)

Methods:

firstNonBlank()

Succeeds if the newComment has been preceded only by blank comments.

This is intended for internal use only!

get()

Generate all the comments in this paragraph

getFirstSentence()

Produce the first "sentence" of this comment block. Later, the definition of "sentence" will be improved.

isLegacy()

Succeed if this comment paragraph appears to be a 'legacy' comment paragraph. A legacy comment paragraph is one that does not start with an HTML key, though it can still contain HTML clauses.

put(newComment)

Add a comment to the paragraph.

size()

Produce the number of lines in this paragraph.

Fields:

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