Improve documentation of separate?.

FossilOrigin-Name: aff81d285aeceef71ea8792ffc4671a0a5d6dd5e118090b5686a0d06767df7e8
programandala-net · Oct 14, 2020 · f268f62 · f268f62
1 parent eae68cf
commit f268f62
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 3 deletions.
diff --git a/VERSION.fs b/VERSION.fs
@@ -3,7 +3,7 @@
 \ This file is part of Fendo
 \ (http://programandala.net/en.program.fendo.html).
 
-: fendo_version ( -- ca len ) s" 0.6.0-pre.58+202010131851" ;
+: fendo_version ( -- ca len ) s" 0.6.0-pre.59+202010141756" ;
 
 \ vim: filetype=gforth
 
diff --git a/fendo.echo.fs b/fendo.echo.fs
@@ -5,10 +5,10 @@
 
 \ This file defines the words that print to the target HTML file.
 
-\ Last modified 201812081823.
+\ Last modified 202010141752.
 \ See change log at the end of the file.
 
-\ Copyright (C) 2013,2014,2017,2018 Marcos Cruz (programandala.net)
+\ Copyright (C) 2013,2014,2017,2018,2020 Marcos Cruz (programandala.net)
 
 \ Fendo is free software; you can redistribute
 \ it and/or modify it under the terms of the GNU General
@@ -100,6 +100,19 @@ variable target_fid  \ file ID of the HTML target page
 
 variable separate?  \ flag: separate the next item from the current one?
 
+  \ doc{
+  \
+  \ separate? ( -- a )
+  \
+  \ A variable. _a_ is the address of a cell containing a flag, which
+  \ indicates if the next item to be printed must be separated by a
+  \ space from the current one.
+  \
+  \ ``separate?`` is an internal flag to control the printing of the
+  \ HTML code.
+  \
+  \ }doc
+
 false value compact_html?  \ if true, no carriage return is created
 
 \ XXX FIXME 'compact_html? is an experimental config flag for the
@@ -206,5 +219,7 @@ false value compact_html?  \ if true, no carriage return is created
 \ 2018-12-08: Update notation of Forth words in comments and strings.
 \
 \ 2018-12-08: Update notation of page IDs in comments and strings.
+\
+\ 2020-10-14: Improve documentation of `separate?`.
 
 \ vim: filetype=gforth