Skip to content

Commit e87a1eb

Browse files
committed
Add documentation for new parameter
1 parent 7180156 commit e87a1eb

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Framework/API/src/AnalysisDataService.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ std::shared_ptr<const WorkspaceGroup> AnalysisDataServiceImpl::GroupUpdatedNotif
3535
* Check whether the name is valid for the ADS. In release mode, issue a warning but do not return the error.
3636
* In debug mode, return the error string.
3737
* @param name A string containing a possible name for an object in the ADS
38+
* @param printWarning Whether to print a warning if the workspace name is invalid. Default is false. Used to
39+
* avoid the warning printing multiple times per operation.
3840
* @return An empty string if the name is valid or an error message stating the
3941
* problem if the name is unacceptable.
4042
*/

0 commit comments

Comments
 (0)