Skip to content

Commit 790f2d5

Browse files
committed
Add missing doc-string for a remove_exceptions overload
1 parent 0bfe213 commit 790f2d5

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

jbmc/src/java_bytecode/remove_exceptions.cpp

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,18 @@ void remove_exceptions(
626626
remove_exceptions(goto_program);
627627
}
628628

629-
/// removes throws/CATCH-POP/CATCH-PUSH
629+
/// removes throws/CATCH-POP/CATCH-PUSH, replacing them with explicit exception
630+
/// propagation.
631+
/// \param goto_model: model to remove exceptions from. The
632+
/// `@inflight_exception` global may be added to its symbol table if not
633+
/// already present. It will not be initialised; that is the caller's
634+
/// responsibility.
635+
/// \param class_hierarchy: class hierarchy analysis of symbol_table.
636+
/// Only needed if type == REMOVE_ADDED_INSTANCEOF; otherwise may be null.
637+
/// \param message_handler: logging output
638+
/// \param type: specifies whether instanceof operations generated by this pass
639+
/// should be lowered to class-identifier comparisons (using
640+
/// remove_instanceof).
630641
void remove_exceptions(
631642
goto_modelt &goto_model,
632643
message_handlert &message_handler,

0 commit comments

Comments
 (0)