Skip to content

Commit

Permalink
Fix misc doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
emesare committed Jan 25, 2025
1 parent 7751483 commit 170f451
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions rust/src/project.rs
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ impl Project {
/// * `path` - Path to folder on disk
/// * `parent` - Parent folder in the project that will contain the new contents
/// * `description` - Description for created root folder
/// * `progress` - [`ProgressExecutor`] that will be called as the [`ProjectFolder`] is being created
/// * `progress` - [`ProgressCallback`] that will be called as the [`ProjectFolder`] is being created
pub fn create_folder_from_path_with_progress<P, D, PC>(
&self,
path: P,
Expand Down Expand Up @@ -310,7 +310,7 @@ impl Project {
/// Recursively delete a [`ProjectFolder`] from the [`Project`].
///
/// * `folder` - [`ProjectFolder`] to delete recursively
/// * `progress` - [`ProgressExecutor`] that will be called as objects get deleted
/// * `progress` - [`ProgressCallback`] that will be called as objects get deleted
pub fn delete_folder_with_progress<P: ProgressCallback>(
&self,
folder: &ProjectFolder,
Expand Down Expand Up @@ -369,7 +369,7 @@ impl Project {
/// * `folder` - Folder to place the created file in
/// * `name` - Name to assign to the created file
/// * `description` - Description to assign to the created file
/// * `progress` - [`ProgressExecutor`] that will be called as the [`ProjectFile`] is being added
/// * `progress` - [`ProgressCallback`] that will be called as the [`ProjectFile`] is being added
pub fn create_file_from_path_with_progress<P, N, D, PC>(
&self,
path: P,
Expand Down Expand Up @@ -445,7 +445,7 @@ impl Project {
/// * `description` - Description to assign to the created file
/// * `id` - id unique ID
/// * `creation_time` - Creation time of the file
/// * `progress` - [`ProgressExecutor`] that will be called as the [`ProjectFile`] is being created
/// * `progress` - [`ProgressCallback`] that will be called as the [`ProjectFile`] is being created
#[allow(clippy::too_many_arguments)]
pub unsafe fn create_file_from_path_unsafe_with_progress<P, N, D, I, PC>(
&self,
Expand Down Expand Up @@ -512,7 +512,7 @@ impl Project {
/// * `folder` - Folder to place the created file in
/// * `name` - Name to assign to the created file
/// * `description` - Description to assign to the created file
/// * `progress` - [`ProgressExecutor`] that will be called as the [`ProjectFile`] is being created
/// * `progress` - [`ProgressCallback`] that will be called as the [`ProjectFile`] is being created
pub fn create_file_with_progress<N, D, P>(
&self,
contents: &[u8],
Expand Down Expand Up @@ -586,7 +586,7 @@ impl Project {
/// * `description` - Description to assign to the created file
/// * `id` - id unique ID
/// * `creation_time` - Creation time of the file
/// * `progress` - [`ProgressExecutor`] that will be called as the [`ProjectFile`] is being created
/// * `progress` - [`ProgressCallback`] that will be called as the [`ProjectFile`] is being created
#[allow(clippy::too_many_arguments)]
pub unsafe fn create_file_unsafe_with_progress<N, D, I, P>(
&self,
Expand Down
2 changes: 1 addition & 1 deletion rust/src/project/folder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ impl ProjectFolder {
/// Recursively export this folder to disk, returns `true' if the export succeeded
///
/// * `dest` - Destination path for the exported contents
/// * `progress` - [`ProgressExecutor`] that will be called as contents are exporting
/// * `progress` - [`ProgressCallback`] that will be called as contents are exporting
pub fn export_with_progress<S, P>(&self, dest: S, mut progress: P) -> bool
where
S: BnStrCompatible,
Expand Down

0 comments on commit 170f451

Please sign in to comment.