Bug 1574479: clarify relations of `OutputFormatted`, `OutputFormatFlowed`, `OutputPreformatted` in nsIDocumentEncoder.idl. r=hsivonen

Deduced from the code and assertions in it.

Differential Revision: https://phabricator.services.mozilla.com/D42307

--HG--
extra : moz-landing-system : lando
This commit is contained in:
Mirko Brodesser 2019-08-19 07:57:07 +00:00
Родитель 5e6d66382d
Коммит bf3decfac6
1 изменённых файлов: 5 добавлений и 4 удалений

Просмотреть файл

@ -48,6 +48,7 @@ interface nsIDocumentEncoder : nsISupports
const unsigned long OutputSelectionOnly = (1 << 0);
/** Plaintext output: Convert html to plaintext that looks like the html.
* Can't be used in conjunction with `OutputPreformatted`.
* Implies wrap (except inside <pre>), since html wraps.
* HTML, XHTML and XML output: do prettyprinting, ignoring existing formatting.
* XML output : it doesn't implicitly wrap
@ -73,8 +74,8 @@ interface nsIDocumentEncoder : nsISupports
* Output as though the content is preformatted
* (e.g. maybe it's wrapped in a PRE or PRE_WRAP style tag)
* Plaintext output only.
* XXXbz How does this interact with
* OutputFormatted/OutputRaw/OutputPreformatted/OutputFormatFlowed?
* Can't be used together with `OutputFormatted`/`OutputFormatFlowed`.
* XXXbz How does this interact with OutputRaw?
*/
const unsigned long OutputPreformatted = (1 << 4);
@ -95,8 +96,8 @@ interface nsIDocumentEncoder : nsISupports
* but in an important way from normal formatted, and that is that
* lines are space stuffed. This can't (correctly) be done later.
* PlainText output only.
* XXXbz How does this interact with
* OutputFormatted/OutputRaw/OutputPreformatted/OutputWrap?
* If this flag is set, `OutputFormat` has to be set too.
* XXXbz How does this interact with OutputRaw/OutputWrap?
*/
const unsigned long OutputFormatFlowed = (1 << 6);