Ticket #9610 (assigned)
Add algorithm usage examples (cloned)
Reported by: | Nick Draper | Owned by: | Peter Peterson |
---|---|---|---|
Priority: | critical | Milestone: | Release 3.5 |
Component: | Documentation | Keywords: | |
Cc: | Blocked By: | #9572 | |
Blocking: | Tester: |
Description (last modified by Peter Peterson) (diff)
Cloned from #9572:
There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus and Rebin.
To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.
In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.
If you are using Linux/Mac look here: https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md
- ResampleX.cpp
- ConvertToEventWorkspace.cpp
AnyShapeAbsorption.cppnow in #9638- ApplyTransmissionCorrection.cpp
- ChangePulsetime.cpp
- FindPeakBackground.cpp
- ClearMaskFlag.cpp
- RadiusSum.cpp
- CloneWorkspace.cpp
- ResetNegatives.cpp
- ModeratorTzero.cpp
- ModeratorTzeroLinear.cpp
- ConvertToHistogram.cpp
- ConvertToPointData.cpp
- SetUncertainties.cpp
- PointByPointVCorrection.cpp
- MaskDetectorsIf.cpp
- CalibrateRectangularDetectors.py
- PDDetermineCharacterizations.py
- NexusTester.cpp
- PDLoadCharacterizations.cpp
- RawFileInfo.cpp
- SaveCalFile.cpp
- SaveIsawDetCal.cpp
- SetSampleMaterial.cpp
- SaveIsawQvector.cpp
- RemoveLowResTOF.cpp
Change History
comment:2 Changed 6 years ago by Peter Peterson
- Status changed from new to assigned
- Description modified (diff)
comment:3 Changed 6 years ago by Peter Peterson
- Description modified (diff)
- Summary changed from Check Documentation and add algorithm usage examples (cloned) to Add algorithm usage examples (cloned)
comment:5 Changed 6 years ago by Peter Peterson
- Description modified (diff)
Removing AnyShapeAbsorption from the list