Mercurial > octave

changeset 29987:79b5a8901efd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* mk-octave-config-h.sh: Use '//' for initial comments.
author John W. Eaton <jwe@octave.org>
date Tue, 17 Aug 2021 21:42:48 -0400
parents 3f598ae945f2
children b113fd9687ee
files build-aux/mk-octave-config-h.sh
diffstat 1 files changed, 28 insertions(+), 32 deletions(-) [+]
line wrap: on
line diff
--- a/build-aux/mk-octave-config-h.sh	Tue Aug 17 21:37:21 2021 -0400
+++ b/build-aux/mk-octave-config-h.sh	Tue Aug 17 21:42:48 2021 -0400
@@ -66,39 +66,35 @@
 //
 ////////////////////////////////////////////////////////////////////////
 
-/*
-
-All Octave source files should begin with
-
-  #if defined (HAVE_CONFIG_H)
-  #  include "config.h"
-  #endif
-
-All public Octave header files should have the form
-
-  #if ! defined (INCLUSION_GUARD_SYMBOL)
-  #define INCLUSION_GUARD_SYMBOL 1
-
-  #include "octave-config.h"
-
-  // Contents of header file.
+// All Octave source files should begin with
+//
+//   #if defined (HAVE_CONFIG_H)
+//   #  include "config.h"
+//   #endif
+//
+// All public Octave header files should have the form
+//
+//   #if ! defined (INCLUSION_GUARD_SYMBOL)
+//   #define INCLUSION_GUARD_SYMBOL 1
+//
+//   #include "octave-config.h"
+//
+//   ... Contents of header file ...
+//
+//   #endif
 
-  #endif
-
-In Octave source files, INCLUSION_GUARD_SYMBOL should have the form
-
-  octave_NAME_h
-
-with NAME formed from the header file name with '-' replaced by '_'.
-
-It is safe to include octave-config.h unconditionally since it will
-expand to an empty file if it is included after Octave's
-autoconf-generated config.h file.
-
-Users of Octave's libraries should not need to include octave-config.h
-since all of Octave's header files already include it.
-
-*/
+// In Octave source files, INCLUSION_GUARD_SYMBOL should have the form
+//
+//   octave_NAME_h
+//
+// with NAME formed from the header file name with '-' replaced by '_'.
+//
+// It is safe to include octave-config.h unconditionally since it will
+// expand to an empty file if it is included after Octave's
+// autoconf-generated config.h file.
+//
+// Users of Octave's libraries should not need to include octave-config.h
+// since all of Octave's header files already include it.
 
 #if ! defined (octave_octave_config_h)
 #define octave_octave_config_h 1