Skip to content

Commit a277169

Browse files
committed
refactoring
1 parent 0c528ed commit a277169

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

jcp/src/main/java/com/igormaznitsa/jcp/containers/FileInfoContainer.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -432,25 +432,27 @@ private void flushTextBufferForRemovedComments(final StringBuilder textBuffer,
432432
}
433433

434434
/**
435-
* Preprocess file, NB! it doesn't clear local variables automatically for cloned contexts
435+
* Preprocess the file described by the object, <b>NB! it doesn't clear local variables automatically for cloned contexts</b>
436436
*
437437
* @param state the start preprocessing state, can be null
438438
* @param context the preprocessor context, must not be null
439439
* @return the state for the preprocessed file
440440
* @throws IOException it will be thrown for IO errors
441441
* @throws PreprocessorException it will be thrown for violation of preprocessing logic, like undefined variable
442+
* @see #preprocessFileWithNotification(PreprocessingState, PreprocessorContext, boolean)
442443
*/
443444
public PreprocessingState preprocessFile(final PreprocessingState state,
444445
final PreprocessorContext context) throws IOException {
445446
return this.preprocessFileWithNotification(state, context, true);
446447
}
447448

448449
/**
449-
* Preprocess file, <b>NB! it doesn't clear local variables automatically for cloned contexts</b>
450+
* Preprocess the file described by the object, <b>NB! it doesn't clear local variables automatically for cloned contexts</b>
450451
*
451452
* @param state the start preprocessing state, can be null
452453
* @param context the preprocessor context, must not be null
453-
* @param notifyProcessors send notification to all processors registered in context about start and stop, it should be true for direct call of preprocess of standalone file. Works only for non-cloned contexts.
454+
* @param notifyProcessors send notification to all processors registered in context about start and stop,
455+
* it should be true for direct call of preprocess of standalone file. <b>Works only for non-cloned contexts.</b>
454456
* @return the state for the preprocessed file
455457
* @throws IOException it will be thrown for IO errors
456458
* @throws PreprocessorException it will be thrown for violation of preprocessing logic, like undefined variable

0 commit comments

Comments
 (0)