uk.ac.starlink.table

## Interface Documented

- All Known Subinterfaces:
    DocumentedIOHandler
  All Known Implementing Classes:
    AbstractTextTableWriter, AsciiTableBuilder, AsciiTableWriter, CdfTableBuilder, ClassTableScheme, ColFitsPlusTableWriter, ColFitsTableBuilder, CsvTableBuilder, CsvTableWriter, DocumentedStreamStarTableWriter, DocumentedTableBuilder, EcsvTableBuilder, EcsvTableWriter, FeatherTableBuilder, FeatherTableWriter, FitsPlusTableWriter, FitsTableBuilder, GbinTableBuilder, HTMLTableWriter, IpacTableBuilder, IpacTableWriter, JDBCTableScheme, LatexTableWriter, LoopTableScheme, MirageTableWriter, MrtTableBuilder, ParquetTableBuilder, ParquetTableWriter, TestTableScheme, TextTableWriter, TstTableBuilder, TstTableWriter, VOTableBuilder, VOTableWriter, WDCTableBuilder

      public interface Documented

  Mixin interface that provides extended user documentation for an object.
  Since:
    4 Sep 2020

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.String` | `getXmlDescription()` Returns user-directed documentation in XML format.

- - ### Method Detail

    - #### getXmlDescription

          java.lang.String getXmlDescription()

      Returns user-directed documentation in XML format.

      The output should be a sequence of one or more <P> elements, using XHTML-like XML. Since rendering may be done in a number of contexts however, use of the full range of XHTML elements is discouraged. Where possible, the content should stick to simple markup such as the elements P, A, UL, OL, LI, DL, DT, DD EM, STRONG, I, B, CODE, TT, PRE.

      Returns:
        XML description of this object