BrTag

Michalis Kamburelis edited this page Jan 7, 2017 · 4 revisions
Clone this wiki locally

Tag @br forces a line break. E.g. <br> in HtmlOutput or \\ in LatexOutput.

Example:

{ 1st paragraph. @br Second line of 1st paragraph.

  2nd paragraph. Blah blah blah.

  3rd paragraph. @br
  Second line of 3rd paragraph. }
procedure TestLineBreak;

Note that it’s not adviced to use this tag too often, since it makes documentation ugly. In HTML, browser window should determine line width, in LaTeX, page width should determine line width, and so on. If you want to start new paragraph you should just insert an empty line (see WritingDocumentation) in description. It’s possible that in some future output formats @br tag will be ignored (or equivalent to starting new paragraph) if line break will not be possible to express in this output format.