Add overview documentation for the remove_java_new [DOC-25] #2773
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thk123
requested review from
cesaro,
cristina-david,
mgudemann,
NathanJPhillips,
peterschrammel,
pkesseli and
smowton
as code owners
thk123
force-pushed
the
doc/remove-java-new
branch
from
e60e82a to
177d72a
Compare
jbmc/src/java_bytecode/README.md
Outdated
|
|
||
| These are converted by \ref remove_java_newt::lower_java_new_array | ||
|
|
||
| See TODO:details about java arrays for details on how arrays are represented in codet. It first allocates the array object as with a regular Java object. Then the size component is set to be the size of the array and the data component is also initialized. |
jbmc/src/java_bytecode/README.md
Outdated
| @@ -37,7 +37,95 @@ To be documented. | |||
|
|
|||
| \section java-bytecode-remove-java-new Remove java new | |||
There was a problem hiding this comment.
Improve heading, maybe: Remove new, newarray and multinewarray Operators
jbmc/src/java_bytecode/README.md
Outdated
| @@ -37,7 +37,95 @@ To be documented. | |||
|
|
|||
| \section java-bytecode-remove-java-new Remove java new | |||
|
|
|||
| To be documented. | |||
| \ref remove_java_new.h is responsible for converting the `new`, `newarray` and `multianewarray` Java bytecode operation into codet. Specifically it converts the bytecode instruction into: | |||
jbmc/src/java_bytecode/README.md
Outdated
| @@ -37,7 +37,95 @@ To be documented. | |||
|
|
|||
| \section java-bytecode-remove-java-new Remove java new | |||
|
|
|||
| To be documented. | |||
| \ref remove_java_new.h is responsible for converting the `new`, `newarray` and `multianewarray` Java bytecode operation into codet. Specifically it converts the bytecode instruction into: | |||
| - An ALLOC with the size of the object being created | |||
There was a problem hiding this comment.
Be more precise what ALLOC is.
|
@peterschrammel comments addressed in a separate commit for easy reviewing - will squash before merging. |
|
Also wrapped text as a separate commit but will squash when done. |
jbmc/src/java_bytecode/README.md
Outdated
|
|
||
| These are converted by \ref remove_java_newt::lower_java_new_array | ||
|
|
||
| See TODO: DOC-20: for details on how arrays are represented in codet. It first |
There was a problem hiding this comment.
This reference is not useful because DOC-20 is nothing public. Refer to some entity within this document or create a new ticket that covers this TODO.
peterschrammel
approved these changes
Aug 30, 2018
thk123
force-pushed
the
doc/remove-java-new
branch
from
4428ed4 to
d1dc554
Compare
thk123
force-pushed
the
doc/remove-java-new
branch
from
d1dc554 to
fa6ed33
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added overview of the
remove_java_newphase.Reviewers - do you think this is too much detail for an overview? I'm thinking perhaps killing all the subsections and moving them into the methods they talk about or perhaps into the documentation for the header file.
Zip containing the updated header file to aid reviewing: group__java__bytecode.html.zip