libs/Message: Improve documentation
authorBrad Jorsch <bjorsch@wikimedia.org>
Thu, 29 Aug 2019 20:52:27 +0000 (16:52 -0400)
committerBrad Jorsch <bjorsch@wikimedia.org>
Thu, 29 Aug 2019 21:04:01 +0000 (17:04 -0400)
commitce79d607c76029e7076672f23d713d1bc1e4fac5
tree1b2a8cade69bb24a33fd33028924814d71503d1a
parent09cd8eb0807ee7b0a94c674766e2ea201e5d071b
libs/Message: Improve documentation

Among other things, this removed mention of MediaWiki classes from the
library and adds a README.md that attempts to define constraints for
interoperability between libraries producing MessageValues and formatter
implementations that are expected to handle them.

This also renames "TextParam" to "ScalarParam", as that seems a more
accurate name for the class.

Change-Id: I264dd4de394d734a87929cf4740779e7b7d0e04a
includes/libs/Message/ITextFormatter.php
includes/libs/Message/ListParam.php
includes/libs/Message/ListType.php
includes/libs/Message/MessageParam.php
includes/libs/Message/MessageValue.php
includes/libs/Message/ParamType.php
includes/libs/Message/README.md [new file with mode: 0644]
includes/libs/Message/ScalarParam.php [new file with mode: 0644]
includes/libs/Message/TextParam.php [deleted file]
tests/phpunit/includes/Message/TextFormatterTest.php
tests/phpunit/includes/libs/Message/MessageValueTest.php