Commit a5e673f8 authored by Yuri Chornoivan's avatar Yuri Chornoivan

Fix minor Doxygen issues

parent 1c32380b
......@@ -72,12 +72,12 @@ namespace KateFileActions
/**
* Runs an external program to compare the underlying files of two given documents.
*
* @param diffExecutable tested to work with "kdiff3", "kompare", and "meld"
* (@see supportedDiffTools())
* @p diffExecutable tested to work with "kdiff3", "kompare", and "meld"
* @see supportedDiffTools()
*
* The parameters documentA and documentB must not be nullptr. Otherwise an assertion fails.
*
* If documentA or documentB have an empty url,
* If @p documentA or @p documentB have an empty url,
* then an empty string is passed to the diff program instead of a local file path.
*
* @returns true if program was started successfully; otherwise false
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment