Переглянути джерело

Module description doc comments

Arthur Yefimov 2 роки тому
батько
коміт
377799baf7
12 змінених файлів з 14 додано та 24 видалено
  1. 1 0
      src/Editor.Mod
  2. 2 1
      src/EditorText.Mod
  3. 2 0
      src/FoStrings.Mod
  4. 1 0
      src/Fob.Mod
  5. 1 0
      src/FreeOberon.Mod
  6. 2 1
      src/Func.Mod
  7. 1 1
      src/GTest.Mod
  8. 1 0
      src/OV.Mod
  9. 1 1
      src/TTest.Mod
  10. 1 0
      src/TermSnow.Mod
  11. 0 20
      src/TestModule.Mod
  12. 1 0
      src/Tetragon.Mod

+ 1 - 0
src/Editor.Mod

@@ -18,6 +18,7 @@ along with Free Oberon.  If not, see <http://www.gnu.org/licenses/>.
 *)
 IMPORT OV, T := TermBox, Text := EditorText, Config, Debug,
   Int, Strings, FoStrings, StrList, Dir, Out;
+(** Free Oberon IDE Editor. Part of Free Oberon IDE internal code *)
 CONST
   dotChar = 0B7X; (* To higlight spaces *)
 

+ 2 - 1
src/EditorText.Mod

@@ -17,7 +17,8 @@ You should have received a copy of the GNU General Public License
 along with Free Oberon.  If not, see <http://www.gnu.org/licenses/>.
 *)
 IMPORT Config, Func, Files, Strings, Out, Utf8;
-
+(** Free Oberon Editor Oberon Vision object. Part of Free Oberon IDE
+    internal code *)
 CONST
   lineLen = 256;
 

+ 2 - 0
src/FoStrings.Mod

@@ -1,4 +1,6 @@
 MODULE FoStrings;
+(** Free Oberon string handling procedures. Part of Free Oberon IDE
+    internal code *)
 IMPORT Strings, Texts, Int, Dir, Env, Out;
 
 CONST

+ 1 - 0
src/Fob.Mod

@@ -17,6 +17,7 @@ You should have received a copy of the GNU General Public License
 along with Free Oberon.  If not, see <http://www.gnu.org/licenses/>.
 *)
 IMPORT FoStrings, Builder, Config, Args, Strings, Out, Platform, Kernel;
+(** Free Oberon Console Compiler. Part of Free Oberon IDE internal code *)
 
 PROCEDURE Usage;
 VAR s: ARRAY 256 OF CHAR;

+ 1 - 0
src/FreeOberon.Mod

@@ -18,6 +18,7 @@ along with Free Oberon.  If not, see <http://www.gnu.org/licenses/>.
 *)
 IMPORT T := TermBox, Files, Args, Utf8, Builder, Env, Debug, Graph,
        OV, Editor, Term, FoStrings, Config, Strings, Int, Out, Kernel;
+(** Free Oberon IDE and Compiler. Part of Free Oberon IDE internal code *)
 CONST
   (* Direction of Selection *)
   dirLeft  = 0;

+ 2 - 1
src/Func.Mod

@@ -1,8 +1,9 @@
 MODULE Func;
+(** Functions. Part of Free Oberon IDE internal code *)
 IMPORT Config;
 
-(** Replace all / with \ if on Windows *)
 PROCEDURE FixFname*(VAR s: ARRAY OF CHAR);
+(** Replace all / with \ if on Windows *)
 VAR i: INTEGER;
 BEGIN
   IF Config.pathDelimiter = '\' THEN i := 0;

+ 1 - 1
src/GTest.Mod

@@ -1,4 +1,4 @@
-(* Graph Test Module *)
+(** Graph Test Module *)
 MODULE GTest;
 IMPORT G := Graph, Random, Out;
 VAR main: G.Window;

+ 1 - 0
src/OV.Mod

@@ -17,6 +17,7 @@ You should have received a copy of the GNU General Public License
 along with Free Oberon.  If not, see <http://www.gnu.org/licenses/>.
 *)
 IMPORT T := TermBox, Strings, StrList, Out, SYSTEM, Kernel;
+(** Oberon Vision *)
 CONST
   minInt = -70000000H-1;
   maxInt = 7FFFFFFFH;

+ 1 - 1
src/TTest.Mod

@@ -1,4 +1,4 @@
-(* TermBox Test Module *)
+(** TermBox Test Module *)
 MODULE TTest;
 IMPORT T := TermBox, Out, Kernel;
 VAR ch: CHAR;

+ 1 - 0
src/TermSnow.Mod

@@ -1,4 +1,5 @@
 MODULE TermSnow;
+(** TermSnow - an example program using TermBox *)
 IMPORT T := TermBox, Out, Random, Kernel;
 
 TYPE

+ 0 - 20
src/TestModule.Mod

@@ -1,20 +0,0 @@
-MODULE TestModule;
-TYPE R = RECORD END;
-
-PROCEDURE Q(r: R);
-BEGIN
-
-END Q;
-
-PROCEDURE P(r: R);
-BEGIN
-  Q(r)
-END P;
-
-PROCEDURE Do;
-VAR x: R;
-BEGIN
-  P(x)
-END Do;
-
-END TestModule.

+ 1 - 0
src/Tetragon.Mod

@@ -1,4 +1,5 @@
 MODULE Tetragon;
+(** Another TermBox usage example module *)
 IMPORT T := TermBox, Out, Random, Kernel;
 CONST
   maxW = 19; maxH = 12; (* Field maximum size *)