diff --git a/lectures/revealjs/07-documentation.adoc b/lectures/revealjs/07-documentation.adoc index 199f047e1d323dcf38c4d4af167c149f8eddfc65..aa516f8fcc21f100915565c130b7be21f6bd3bf5 100644 --- a/lectures/revealjs/07-documentation.adoc +++ b/lectures/revealjs/07-documentation.adoc @@ -79,25 +79,25 @@ https://stfalcon.com/uploads/images/55c8bcff18b94.png == Comments (3) -``` java - /** - * Creates a LatLong object from a String, using a specific separator. - * The format is <latitude><separator><longitude>. - * @param s the String to parse - * @param sep the separator - * @return the new LatLong object - */ - public static LatLong valueOf(final String s, final String sep) { - final int pos = s.indexOf(sep); - if (pos < 0) { - throw new IllegalArgumentException("No '" + sep + "' in " + s); - } - final double lat = Double.valueOf(s.substring(0, pos).trim()); - final double lon = Double.valueOf(s.substring(pos + sep.length()).trim()); - - return new LatLong(lat, lon); - } -``` +[source,java, role="stretch"] +---- +/** + * Creates a LatLong object from a String, using a specific separator. + * The format is <latitude><separator><longitude>. + * @param s the String to parse + * @param sep the separator + * @return the new LatLong object + */ +public static LatLong valueOf(final String s, final String sep) { + final int pos = s.indexOf(sep); + if (pos < 0) { + throw new IllegalArgumentException("No '" + sep + "' in " + s); + } + final double lat = Double.valueOf(s.substring(0, pos).trim()); + final double lon = Double.valueOf(s.substring(pos + sep.length()).trim()); + return new LatLong(lat, lon); +} +---- == Over-documenting @@ -121,7 +121,7 @@ https://miro.medium.com/max/1138/1*Pyxsc7Uixbitv5myywaA_Q.jpeg (Gary Larson comi == Markdown [.center-paragraph] -Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML.[8] Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. +Markdown is a lightweight markup language with plain text formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. [.smaller-40] https://en.wikipedia.org/wiki/Markdown