Change alg summary strings to a single setSummary

[Peter Peterson]

We have several methods for documenting alg Algorithm::getOptionMessage, Algorithm::getWikiSummary and an unused alg::getWikiDescription. This is confusing and are badly named. Change this to only have a single summary method.

This is critical as it is linked to the migration of the algorithms to the new documentation approach.

[Nick Draper]

After discussion with Martyn we need to make bigger changes here. Description and header changed.

[Peter Peterson]

There are two methods because getOptionalMessage is a plain string, where getWikiSummary can have mediawiki markup. I agree that the names are bad, but it may still be useful to have the option of richer strings.

[Nick Draper]

re #9523 Algorithms and API changed

Changeset: 83961ad9baa5a96f02c1fb4be664e4d32a5180ed

[Nick Draper]

re #9523 Crystal, CurveFitting, DataHandling, ICat and ISISLiveData

Changeset: 028174e8bfe5f80300cf4c2d9d05d3b1a6b18139

[Nick Draper]

Also changed the CLassMaker.py script in the last commit

The next library to do is LiveData.

Also I have not run the unit tests yet.

The process is to run the migration script

C:\Mantid\Code\Tools\DocMigration>MigrateOptMessage.py "C:\Mantid\Code\Mantid\Fr
amework\ISISLiveData\src"

followed by:

1. compile the library, and sort out any failures. Common ones are
   1. The summary message could not be found, so strip it out of init docs and put in a summary into the header yourself. Delete initdocs while you are at it.
   2. The summary was put into the header is a way that disrupted the name function, just move it.
2. When you get linker errors
   1. Most will be down to initdocs search across all files and remove initdocs lies.
   2. (Rarer)Remaining ones might be due to multiline comments removing large amounts of code

[Nick Draper]

The code branch id pushed to github

feature/9523_Tie_alg_summary_messages

[Martyn Gigg]

Allow doc migrate tool to use subdirectories

Refs #9523

Changeset: ca9b3bf99a3af2660c96d57c28cf07ec5f0e9256

[Martyn Gigg]

Convert to summary method in MDEvent/MDAlgorithms

Refs #9523

Changeset: 2e6e5515b41febdabbeb08450edd7ad940739007

[Martyn Gigg]

Fix warnings in DataHandling. Refs #9523

Changeset: b518ab92dee3903316c0ad55da6bdf6276cb8495

[Martyn Gigg]

Deprecated algorothm wiki methods in Python

Refs #9523

Changeset: 5106ea756f80627338a9246cf9008b28f9928ce0

[Martyn Gigg]

We could allow strings with richer formatting by adding a method something like

virtual std::string IAlgorithm::markupSummary() const { return this->summary(); }

that algorithms can override if they choose to but by default would return the plain text version?

[Jay Rainey]

Added summary method to MantidRemoteAlgorithms. Refs #9523.

Changeset: 3bdb013fc60ff4d15ab37b8e678e5fb0f0caf380

[Jay Rainey]

Added summary method to SINQ algorithms. Refs #9523.

Changeset: 31a67ca8427715fda8792cd9228648c607a8f444

[Jay Rainey]

Added summary method to WorkFlow algorithms. Refs #9523.

Changeset: cfa2912ec1a50f9d1cbe7e3ac3df573657d01a34

[Jay Rainey]

Added summary method to LiveData algorithms. Refs #9523.

Changeset: e3662a0f52babc205de053bd7dcaaa65bb858093

[Jay Rainey]

Fix warnings left by Python script. Refs #9523.

Changeset: 686ab2154655215dbfe55aa0e11441ac5c3d3d08

[Jay Rainey]

Update calls to getOptionalMessage to be summary. Refs #9523.

Changeset: e53d82f1f9f0774efc1553026656af323bf27baa

[Jay Rainey]

Add summary to user algorithms. Refs #9523.

• Default implementation is not provided in Algorithm.cpp, so we must add it to all files that inherit from IAlgorithm.

Changeset: b1ad521f3b345253bd3cc21beeb6832aee137201

[Jay Rainey]

Update tests to have a dummy summary. Refs #9523.

Changeset: 1f251559f9bdcf2a0c885e9e04a1c0fc7682e757

[Jay Rainey]

Fix additional Python generated warnings. Refs #9523.

Changeset: 148d85bbc6df2038d49c2adeb4f5d903168e7f77

[Jay Rainey]

Update other algorithms on develop to fix build. Refs #9523.

Changeset: 749b5b9b51f83f348cc68b8cfdc1fd71f165b2c8

[Jay Rainey]

Added blocking to those algorithms I have modified on develop, which need their documentation calls updated, e.g. when this ticket is merged into master.

[Jay Rainey]

No initDocs left behind. Refs #9523.

Changeset: 333cb547ebc04f93849d796a5de9da3346a20797

[Jay Rainey]

Forgot to remove initDocs from ChopEventFilters. Refs #9523.

Changeset: 0e3bdfd3e83e0781840ac8b25ca24b111fa56ef9

[Jay Rainey]

Add summary method to Python algorithms. Refs #9523.

Changeset: d973996852574ceae1770cc00cc97044ca43354c

[Jay Rainey]

Attempt to fix builds. Refs #9523.

Changeset: 6ccacb4ca82c2b5f39a062ce1963b42fc59debb8

[Jay Rainey]

Attempt to fix build servers. Refs #9523.

Changeset: a960a458dd22823a162a7529fd682d97ccfcfc6b

[Martyn Gigg]

Fix mediaiwiki parser for non-lists that have multiple stars in line

Refs #9523

Changeset: 1cf43a5bca70b1be02f81b1d293e81f100dd3d03

[Martyn Gigg]

Fix indentation problems in PythonAlgorithms.

Fixes warning messages about failing to load plugins. Refs #9523

Changeset: 0b5321c5052ac8f71382dd304b8c4c1122119490

[Martyn Gigg]

Remove migration python tool

Refs #9523

Changeset: 0540c103f9caa90a10dc353d578b147a05b0fef8

[Martyn Gigg]

Merge remote-tracking branch 'origin/feature/9523_Tie_alg_summary_messages'

Full changeset: ​17c86856523772f323bc9922219791daa42ede79

[Stuart Campbell]

This ticket has been transferred to github issue ​10366