Skip to content

docs: Update documentation comments in FileUpdateTransaction.h #1210

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
rwalworth merged 4 commits into from
Mar 10, 2026
Merged

docs: Update documentation comments in FileUpdateTransaction.h #1210

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aeac966
Update FileUpdateTransaction.h
freya-docs Mar 9, 2026
4392937
Merge branch 'hiero-ledger:main' into improve-doc-clarity
freya-docs Mar 10, 2026
756cf76
Update FileUpdateTransaction.h
freya-docs Mar 10, 2026
d5b15e9
Wrap the line in FileUpdateTransaction.h
freya-docs Mar 10, 2026
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
7 changes: 3 additions & 4 deletions src/sdk/main/include/FileUpdateTransaction.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ class FileUpdateTransaction : public Transaction<FileUpdateTransaction>
FileUpdateTransaction& setExpirationTime(const std::chrono::system_clock::time_point& expirationTime);

/**
* Set the new key(s) that must sign when mutating the file.
* Set the Keys that must sign when mutating the new file via FileAppendTransactions or FileUpdateTransactions.
*
* @param keys The keys that must sign any Transaction that edits the created file.
* @return A reference to this FileUpdateTransaction object with the newly-set keys.
Expand All @@ -82,8 +82,7 @@ class FileUpdateTransaction : public Transaction<FileUpdateTransaction>
FileUpdateTransaction& setKeys(const KeyList& keys);

/**
* Set the new contents of the file. The contents cannot exceed 4096 bytes. A FileAppendTransaction must be used to
* set larger contents.
* Set the new contents of the file by replacing the existing file contents. The contents cannot exceed 4096 bytes. To set larger contents, a FileAppendTransaction must be used.
*
* @param contents The new contents of the file.
* @return A reference to this FileUpdateTransaction object with the newly-set contents.
Expand All @@ -96,7 +95,7 @@ class FileUpdateTransaction : public Transaction<FileUpdateTransaction>
/**
* Set the new memo for the file.
*
* @param memo The new memo of the file.
* @param memo The new memo for the file.
* @return A reference to this FileUpdateTransaction object with the newly-set memo.
* @throws IllegalStateException If this FileUpdateTransaction is frozen.
*/
Expand Down