--- freem/doc/freem.texi 2025/03/06 18:33:26 1.3 +++ freem/doc/freem.texi 2025/03/09 20:14:10 1.4 @@ -6015,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 * Copyright (C) 1998 MUG Deutschland - * Copyright (C) 2020 Coherent Logic Development LLC + * Copyright (C) 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 . + * + * 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