From 0dc4dfca97457dc6f8997234553a39423eed9cfe Mon Sep 17 00:00:00 2001 From: Andrew Harris Date: Thu, 17 Dec 2015 21:10:55 -0330 Subject: [PATCH] Change multiple documentations in DairkiDiff Currently, multiple TODO tags are over different functions and classes in DairkiDiff. Add documentation to five classes and functions in DairkiDiff. Change-Id: I000b615e929736a71aaa4633a291aab94428117f --- includes/diff/DairikiDiff.php | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/includes/diff/DairikiDiff.php b/includes/diff/DairikiDiff.php index 74019923d0..ad6e81e386 100644 --- a/includes/diff/DairikiDiff.php +++ b/includes/diff/DairikiDiff.php @@ -26,7 +26,11 @@ */ /** - * @todo document + * The base class for all other DiffOp classes. + * + * The classes that extend DiffOp are: DiffOpCopy, DiffOpDelete, DiffOpAdd and + * DiffOpChange. FakeDiffOp also extends DiffOp, but it is not located in this file. + * * @private * @ingroup DifferenceEngine */ @@ -93,7 +97,9 @@ abstract class DiffOp { } /** - * @todo document + * Extends DiffOp. Used to mark strings that have been + * copied from one string array to the other. + * * @private * @ingroup DifferenceEngine */ @@ -117,7 +123,9 @@ class DiffOpCopy extends DiffOp { } /** - * @todo document + * Extends DiffOp. Used to mark strings that have been + * deleted from the first string array. + * * @private * @ingroup DifferenceEngine */ @@ -138,7 +146,9 @@ class DiffOpDelete extends DiffOp { } /** - * @todo document + * Extends DiffOp. Used to mark strings that have been + * added from the first string array. + * * @private * @ingroup DifferenceEngine */ @@ -159,7 +169,9 @@ class DiffOpAdd extends DiffOp { } /** - * @todo document + * Extends DiffOp. Used to mark strings that have been + * changed from the first string array (both added and subtracted). + * * @private * @ingroup DifferenceEngine */ -- 2.20.1