Skip to content

stack opcode example comments #3546

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 23, 2024
Merged

stack opcode example comments #3546

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e7ef577
stack opcode example comments
Hecate2 Oct 23, 2024
2c74e36
move index into example
Hecate2 Oct 23, 2024
0b38600
Merge branch 'master' into opcode-examples
Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions src/Neo.VM/OpCode.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,6 +725,8 @@ public enum OpCode : byte
/// <summary>
/// The item n back in the stack is copied to the top.
///
/// <example> a b c d 2 -> a b c d b </example>
/// index => 3[2]1 0
/// <remarks>
/// Push: 1 item(s)
/// Pop: 0 item(s)
Expand All @@ -735,6 +737,8 @@ public enum OpCode : byte
/// <summary>
/// The item at the top of the stack is copied and inserted before the second-to-top item.
///
/// <example> a b c -> a c b c </example>
///
/// <remarks>
/// Push: 1 item(s)
/// Pop: 0 item(s)
Expand Down Expand Up @@ -769,6 +773,8 @@ public enum OpCode : byte
/// <summary>
/// The item n back in the stack is moved to the top.
///
/// <example>a b c d 2 -> a c d b</example>
/// index => 3[2]1 0
Copy link
Member

@shargon shargon Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move index inside example? also '>' must be escaped?

Copy link
Contributor Author

@Hecate2 Hecate2 Oct 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'>' had been written in <summary> everywhere, and it seems escaping is unnecessary. Or, shall I change all the '>'?

/// <remarks>
/// Push: 0 item(s)
/// Pop: 1 item(s)
Expand All @@ -793,7 +799,6 @@ public enum OpCode : byte
///
/// <example> a b c d -> d c b a</example>
///
///
/// <remarks>
/// Push: 0 item(s)
/// Pop: 0 item(s)
Expand All @@ -804,7 +809,8 @@ public enum OpCode : byte
/// <summary>
/// Pop the number N on the stack, and reverse the order of the top N items on the stack.
///
///
/// <example> a b c d 3 -> a d c b </example>
///
/// <remarks>
/// Push: 0 item(s)
/// Pop: 1 item(s)
Expand Down
Loading