--- freem/doc/freem.texi 2025/01/19 02:04:04 1.1
+++ freem/doc/freem.texi 2025/03/23 19:42:18 1.9
@@ -4,10 +4,10 @@
@settitle The FreeM Manual
@copying
-This manual is for FreeM, (version 0.61.2), which is a free and open-source implementation of the M programming language.
+This manual is for FreeM, (version cvs-current), which is a free and open-source implementation of the M programming language.
-Copyright @copyright{} 2014-2024 Coherent Logic Development LLC
+Copyright @copyright{} 2014-2025 Coherent Logic Development LLC
@quotation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover texts, and with no Back-Cover Texts.
@@ -18,7 +18,7 @@ Permission is granted to copy, distribut
@title The FreeM Manual
@subtitle @sc{The Official Manual of FreeM}
-@subtitle Version 0.61.2
+@subtitle Version cvs-current
@c@vskip 10pt
@c@center @image{freem-logo-sm,,,,.png}
@author Serena Willis
@@ -369,7 +369,7 @@ Attempting to start a FreeM interpreter
The FreeM direct-mode environment is the mode entered when FreeM is invoked without the use of @option{-r @emph{<entryref>}} or @option{--routine=@emph{<entryref>}}:
@example
-Coherent Logic Development FreeM version 0.61.2 (x86_64-pc-linux-gnu)
+Coherent Logic Development FreeM version cvs-current (x86_64-pc-linux-gnu)
Copyright (C) 2014, 2020, 2021 Coherent Logic Development LLC
@@ -1139,7 +1139,7 @@ The first argument is a string represent
The second argument is a string representing a valid FreeM class.
-@xref{Object-Oriented Programming}
+
@example
USER> N STR=$$^%STRING
@@ -2434,7 +2434,7 @@ In the above @emph{inclusive} form, @cod
@cartouche
@quotation
@emph{Note}
-The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version 0.61.2, but are planned for a future release.
+The below @emph{argumentless} and @emph{exclusive} forms of @code{KVALUE} are not implemented in FreeM, as of version cvs-current, but are planned for a future release.
@end quotation
@end cartouche
@@ -4369,6 +4369,11 @@ See @ref{Classes}.
@cindex functions, extrinsic
@cindex subroutines
+@menu
+* Subroutines:: Making sections of code reusable.
+* Extrinsic Functions:: Reusable code that returns a value.
+@end menu
+
@node Subroutines
@section Subroutines
@@ -4380,9 +4385,20 @@ See @ref{Classes}.
@cindex object-oriented programming
@cindex programming, object-oriented
+@menu
+* Classes:: The basis of object-oriented programming.
+@end menu
+
@node Classes
@section Classes
+@menu
+* Inheritance:: Basing one class upon another.
+* Methods:: Attaching code to a class.
+* Public Variables:: Variables visible outside of a class.
+* Private Variables:: Variables only visible within a class.
+@end menu
+
@node Inheritance
@subsection Inheritance
@@ -4395,7 +4411,6 @@ See @ref{Classes}.
@node Private Variables
@subsection Private Variables
-
@node Libraries
@chapter Libraries
@cindex libraries
@@ -6000,37 +6015,40 @@ WRITE $VIEW(31),!
@section Module Headers
@cindex coding standards, module headers
-Module headers should adhere to the following format:
+Module headers should adhere to the following format (where @code{Dollar} should be replaced with a dollar sign):
@verbatim
/*
- * *
- * * *
- * * *
- * ***************
- * * * * *
- * * MUMPS *
- * * * * *
- * ***************
- * * *
- * * *
- * *
- *
- * mlib.h
+ * DollarIdDollar
* Function prototypes, structs, and macros for FreeM
* binding library
*
*
* Author: Serena Willis <jpw@coherent-logic.com>
* Copyright (C) 1998 MUG Deutschland
- * Copyright (C) 2020 Coherent Logic Development LLC
+ * Copyright (C) <Year> Coherent Logic Development LLC
+ *
+ * This file is part of FreeM.
+ *
+ * FreeM is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * FreeM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero Public License
+ * along with FreeM. If not, see <https://www.gnu.org/licenses/>.
+ *
+ * DollarLogDollar
*
- * Last modified: 29 February 2020
- *
+ * SPDX-FileCopyrightText: (C) 2025 Coherent Logic Development LLC
+ * SPDX-License-Identifier: AGPL-3.0-or-later
**/
@end verbatim
-@cindex ha-Ashkenaz, Shalom
-The Star of David in module headers is a convention started by Shalom ha-Ashkenaz, the unidentified original author of FreeMUMPS/FreeM. We will continue to employ it in honor of his most valuable contribution to the M community.
@section Variable Naming
@cindex coding standards, variable naming