Skip to content

Commit

Permalink
Remove doxygen warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
gesnerpassos committed Jul 15, 2013
1 parent 279349e commit 6dddbac
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 24 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@ namespace Mantid
{
/** @class SaveCanSAS1D2 DataHandling/SaveCanSAS1D2.h
@verbatim
This algorithm saves workspace into CanSAS1d format. This is an xml format except
the <Idata>, </Idata> tags and all data in between must be one line, which necesitates
the \<Idata\>, \<\/Idata\> tags and all data in between must be one line, which necesitates
the files be written iostream functions outside xml libraries.
The second version of CanSAS1D implements the version 1.1, whose schema is found at
Expand All @@ -42,11 +40,11 @@ namespace Mantid
- Introduction of 2 new (optional) workspace properties:
- Transmission - The workspace for of the transmission
- TransmissionCan - The workspace for the transmission can
- Extension of the ::init method in order to introduce these workspaces properties.
- Overide the ::createSASRootElement to conform the new header.
- Introduction of the method to deal with the new element: ::createSASTransElement.
- Override the ::exec method to introduce this new element when apropriated.
- Override the ::writeHeader method to introduce set the correct stylesheet
- Extension of the SaveCanSAS1D2::init method in order to introduce these workspaces properties.
- Overide the SaveCanSAS1D2::createSASRootElement to conform the new header.
- Introduction of the method to deal with the new element: SaveCanSAS1D2::createSASTransElement.
- Override the SaveCanSAS1D2::exec method to introduce this new element when apropriated.
- Override the SaveCanSAS1D2::writeHeader method to introduce set the correct stylesheet
@author Gesner Passos, Rutherford Appleton Laboratory
@date 11/04/2013
Expand Down
2 changes: 1 addition & 1 deletion Code/Mantid/Framework/DataHandling/src/SaveCanSAS1D2.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ void SaveCanSAS1D2::createSASRootElement(std::string& rootElem)
}

/** This method creates an XML element named "SAStransmission_spectrum"
* @param sasData :: string for sasdata element in the xml
* @param sasTrans :: string for sasdata element in the xml
* @param name :: name of the type of spectrum. Two values are acceptable: sample, can
*/
void SaveCanSAS1D2::createSASTransElement(std::string& sasTrans, const std::string & name)
Expand Down
24 changes: 12 additions & 12 deletions Code/Mantid/MantidQt/API/inc/MantidQtAPI/RepoModel.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,22 +49,22 @@ const QString DELETABLEENTRY = "deletable";
with the ScriptRepository through the Qt ModelView Framework.
The requirements for a class to fit this framework is to reimplement the following methods:
- ::data - giving access to the data
- ::flags - indication of the allowed interaction
- ::headerData
- ::index
- ::parent
- ::rowCount
- ::columnCount
- ::setData
- RepoModel::data - giving access to the data
- RepoModel::flags - indication of the allowed interaction
- RepoModel::headerData
- RepoModel::index
- RepoModel::parent
- RepoModel::rowCount
- RepoModel::columnCount
- RepoModel::setData
Through these methods, the RepoModel will be able to provide access to the ScriptRepository
service. Allowing the users to upload and download files and folders.
Some extra services are provided, to allow the classes to show the description of the files
as well as open the files to be inspected by the users:
- ::entrySelected
- ::fileSelected
- entrySelected
- fileSelected
This class should be constructed just once, and as so, the copy constructor and the assignment
will be make private to ensure this.
Expand Down Expand Up @@ -97,8 +97,8 @@ const QString DELETABLEENTRY = "deletable";
This class in indended to keep track of the path inside the Repository
of the entries, in such a way the repomodel will be able to get from the
index the path.
The ::appendChild allows the RepoModel to reconstruct the tree of the directories,
while the ::child and ::parent methods allow to iterate over the tree.
The RepoModel::appendChild allows the RepoModel to reconstruct the tree of the directories,
while the RepoModel::child and RepoModel::parent methods allow to iterate over the tree.
*/
class RepoItem
{
Expand Down
6 changes: 3 additions & 3 deletions Code/Mantid/MantidQt/API/src/RepoModel.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,12 @@ void RepoModel::RepoItem::appendChild(RepoItem *child)
}

/** Gives access to the row_th children of RepoItem. Note that
the row can not be greater than ::childCount().
the row can not be greater than RepoModel::childCount().
But we do not test it, because this method will be called
indirectly from the QView, and will never go beyond that value.
@param row: Number between 0 and ::childCount().
@param row: Number between 0 and RepoModel::childCount().
@return The pointer to the row_th children.
Expand Down Expand Up @@ -741,7 +741,7 @@ QString RepoModel::filePath(const QModelIndex & index){
that is a parent. If it does not exists, it should be created.
@param folder: relative path inside the repository for the folder.
@param Reference to the list of parents
@param parents Reference to the list of parents
@return Pointer to the RepoItem related to the given folder.
**/
Expand Down

0 comments on commit 6dddbac

Please sign in to comment.