aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNeil <nyamatongwe@gmail.com>2021-05-09 10:05:50 +1000
committerNeil <nyamatongwe@gmail.com>2021-05-09 10:05:50 +1000
commitbd7646eede0a545d598cfe2d0531d8d5644c3bf6 (patch)
tree047eced9d06c317b76ef1997381c45ea2eca05cd
parentf0c53e7b25f12be66881acc110d815ec491f1533 (diff)
downloadscintilla-mirror-bd7646eede0a545d598cfe2d0531d8d5644c3bf6.tar.gz
Add @file <filename> comments to follow convention.
Fix incorrect filename comments. Normalize Qt code to use #endif /* X */ insetad of #endif // X.
-rw-r--r--cocoa/ScintillaTest/AppController.mm2
-rw-r--r--qt/ScintillaEdit/ScintillaDocument.cpp2
-rw-r--r--qt/ScintillaEdit/ScintillaDocument.h4
-rw-r--r--qt/ScintillaEditBase/PlatQt.cpp2
-rw-r--r--qt/ScintillaEditBase/PlatQt.h2
-rw-r--r--qt/ScintillaEditBase/ScintillaEditBase.cpp2
-rw-r--r--qt/ScintillaEditBase/ScintillaEditBase.h2
-rw-r--r--qt/ScintillaEditBase/ScintillaQt.cpp2
-rw-r--r--qt/ScintillaEditBase/ScintillaQt.h4
-rw-r--r--test/unit/UnitTester.cxx5
-rw-r--r--test/unit/testCellBuffer.cxx4
-rw-r--r--test/unit/testCharClassify.cxx4
-rw-r--r--test/unit/testContractionState.cxx4
-rw-r--r--test/unit/testDecoration.cxx4
-rw-r--r--test/unit/testPartitioning.cxx4
-rw-r--r--test/unit/testPerLine.cxx4
-rw-r--r--test/unit/testRunStyles.cxx4
-rw-r--r--test/unit/testSparseVector.cxx4
-rw-r--r--test/unit/testSplitVector.cxx4
-rw-r--r--test/unit/testUniConversion.cxx4
-rw-r--r--test/unit/unitTest.cxx4
21 files changed, 47 insertions, 24 deletions
diff --git a/cocoa/ScintillaTest/AppController.mm b/cocoa/ScintillaTest/AppController.mm
index e7f96ed7d..97c75945f 100644
--- a/cocoa/ScintillaTest/AppController.mm
+++ b/cocoa/ScintillaTest/AppController.mm
@@ -1,5 +1,5 @@
/**
- * AppController.m
+ * AppController.mm
* ScintillaTest
*
* Created by Mike Lischke on 01.04.09.
diff --git a/qt/ScintillaEdit/ScintillaDocument.cpp b/qt/ScintillaEdit/ScintillaDocument.cpp
index cae99f64b..2272c383c 100644
--- a/qt/ScintillaEdit/ScintillaDocument.cpp
+++ b/qt/ScintillaEdit/ScintillaDocument.cpp
@@ -1,4 +1,4 @@
-// ScintillaDocument.cpp
+// @file ScintillaDocument.cpp
// Wrapper for Scintilla document object so it can be manipulated independently.
// Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
diff --git a/qt/ScintillaEdit/ScintillaDocument.h b/qt/ScintillaEdit/ScintillaDocument.h
index 8ae7414f9..c10d50d42 100644
--- a/qt/ScintillaEdit/ScintillaDocument.h
+++ b/qt/ScintillaEdit/ScintillaDocument.h
@@ -1,4 +1,4 @@
-// ScintillaDocument.h
+// @file ScintillaDocument.h
// Wrapper for Scintilla document object so it can be manipulated independently.
// Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
@@ -88,4 +88,4 @@ signals:
friend class ::WatcherHelper;
};
-#endif // SCINTILLADOCUMENT_H
+#endif /* SCINTILLADOCUMENT_H */
diff --git a/qt/ScintillaEditBase/PlatQt.cpp b/qt/ScintillaEditBase/PlatQt.cpp
index 286441be9..ee4d7be80 100644
--- a/qt/ScintillaEditBase/PlatQt.cpp
+++ b/qt/ScintillaEditBase/PlatQt.cpp
@@ -1,4 +1,4 @@
-//
+// @file PlatQt.cpp
// Copyright (c) 1990-2011, Scientific Toolworks, Inc.
//
// The License.txt file describes the conditions under which this software may be distributed.
diff --git a/qt/ScintillaEditBase/PlatQt.h b/qt/ScintillaEditBase/PlatQt.h
index 898078f75..3b74a1306 100644
--- a/qt/ScintillaEditBase/PlatQt.h
+++ b/qt/ScintillaEditBase/PlatQt.h
@@ -1,4 +1,4 @@
-//
+// @file PlatQt.h
// Copyright (c) 1990-2011, Scientific Toolworks, Inc.
//
// The License.txt file describes the conditions under which this software may be distributed.
diff --git a/qt/ScintillaEditBase/ScintillaEditBase.cpp b/qt/ScintillaEditBase/ScintillaEditBase.cpp
index 7a199b80e..f6da07fe9 100644
--- a/qt/ScintillaEditBase/ScintillaEditBase.cpp
+++ b/qt/ScintillaEditBase/ScintillaEditBase.cpp
@@ -6,7 +6,7 @@
// Author: Jason Haslam
//
// Additions Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
-// ScintillaEditBase.cpp - Qt widget that wraps ScintillaQt and provides events and scrolling
+// @file ScintillaEditBase.cpp - Qt widget that wraps ScintillaQt and provides events and scrolling
#include "ScintillaEditBase.h"
#include "ScintillaQt.h"
diff --git a/qt/ScintillaEditBase/ScintillaEditBase.h b/qt/ScintillaEditBase/ScintillaEditBase.h
index 1c4ea9089..a0375f13d 100644
--- a/qt/ScintillaEditBase/ScintillaEditBase.h
+++ b/qt/ScintillaEditBase/ScintillaEditBase.h
@@ -6,7 +6,7 @@
// Author: Jason Haslam
//
// Additions Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
-// ScintillaWidget.h - Qt widget that wraps ScintillaQt and provides events and scrolling
+// @file ScintillaEditBase.h - Qt widget that wraps ScintillaQt and provides events and scrolling
#ifndef SCINTILLAEDITBASE_H
diff --git a/qt/ScintillaEditBase/ScintillaQt.cpp b/qt/ScintillaEditBase/ScintillaQt.cpp
index aad1da231..710b7de9f 100644
--- a/qt/ScintillaEditBase/ScintillaQt.cpp
+++ b/qt/ScintillaEditBase/ScintillaQt.cpp
@@ -6,7 +6,7 @@
// Author: Jason Haslam
//
// Additions Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
-// ScintillaQt.cpp - Qt specific subclass of ScintillaBase
+// @file ScintillaQt.cpp - Qt specific subclass of ScintillaBase
#include "ScintillaQt.h"
#include "PlatQt.h"
diff --git a/qt/ScintillaEditBase/ScintillaQt.h b/qt/ScintillaEditBase/ScintillaQt.h
index e8ef4d403..adbf11efd 100644
--- a/qt/ScintillaEditBase/ScintillaQt.h
+++ b/qt/ScintillaEditBase/ScintillaQt.h
@@ -6,7 +6,7 @@
// Author: Jason Haslam
//
// Additions Copyright (c) 2011 Archaeopteryx Software, Inc. d/b/a Wingware
-// ScintillaQt.h - Qt specific subclass of ScintillaBase
+// @file ScintillaQt.h - Qt specific subclass of ScintillaBase
#ifndef SCINTILLAQT_H
#define SCINTILLAQT_H
@@ -176,4 +176,4 @@ private:
}
-#endif // SCINTILLAQT_H
+#endif /* SCINTILLAQT_H */
diff --git a/test/unit/UnitTester.cxx b/test/unit/UnitTester.cxx
index f326477c4..d83a803b5 100644
--- a/test/unit/UnitTester.cxx
+++ b/test/unit/UnitTester.cxx
@@ -1,5 +1,6 @@
-// UnitTester.cpp : Defines the entry point for the console application.
-//
+/** @file UnitTester.cxx
+ ** UnitTester.cpp : Defines the entry point for the console application.
+ **/
// Catch uses std::uncaught_exception which is deprecated in C++17.
// This define silences a warning from Visual C++.
diff --git a/test/unit/testCellBuffer.cxx b/test/unit/testCellBuffer.cxx
index aeffed850..22f8a616c 100644
--- a/test/unit/testCellBuffer.cxx
+++ b/test/unit/testCellBuffer.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testCellBuffer.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testCharClassify.cxx b/test/unit/testCharClassify.cxx
index e329c0378..185681c5b 100644
--- a/test/unit/testCharClassify.cxx
+++ b/test/unit/testCharClassify.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testCharClassify.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstring>
diff --git a/test/unit/testContractionState.cxx b/test/unit/testContractionState.cxx
index 04346262b..91672fe27 100644
--- a/test/unit/testContractionState.cxx
+++ b/test/unit/testContractionState.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testContractionState.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testDecoration.cxx b/test/unit/testDecoration.cxx
index 0999bdf6b..bd0b1cd58 100644
--- a/test/unit/testDecoration.cxx
+++ b/test/unit/testDecoration.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testDecoration.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testPartitioning.cxx b/test/unit/testPartitioning.cxx
index 6b109c8d3..fb70380e9 100644
--- a/test/unit/testPartitioning.cxx
+++ b/test/unit/testPartitioning.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testPartitioning.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testPerLine.cxx b/test/unit/testPerLine.cxx
index 2f5e217dc..669a047db 100644
--- a/test/unit/testPerLine.cxx
+++ b/test/unit/testPerLine.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testPerLine.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testRunStyles.cxx b/test/unit/testRunStyles.cxx
index b35b19dae..43d9d5b0f 100644
--- a/test/unit/testRunStyles.cxx
+++ b/test/unit/testRunStyles.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testRunStyles.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testSparseVector.cxx b/test/unit/testSparseVector.cxx
index e40649537..ce84fb8da 100644
--- a/test/unit/testSparseVector.cxx
+++ b/test/unit/testSparseVector.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testSparseVector.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cassert>
diff --git a/test/unit/testSplitVector.cxx b/test/unit/testSplitVector.cxx
index a0f61bbe3..3f5cec3c5 100644
--- a/test/unit/testSplitVector.cxx
+++ b/test/unit/testSplitVector.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testSplitVector.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstddef>
#include <cstring>
diff --git a/test/unit/testUniConversion.cxx b/test/unit/testUniConversion.cxx
index b1fbe1a26..7bbf808ad 100644
--- a/test/unit/testUniConversion.cxx
+++ b/test/unit/testUniConversion.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file testUniConversion.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
#include <cstring>
diff --git a/test/unit/unitTest.cxx b/test/unit/unitTest.cxx
index 31b5716ed..8bcc570ac 100644
--- a/test/unit/unitTest.cxx
+++ b/test/unit/unitTest.cxx
@@ -1,4 +1,6 @@
-// Unit Tests for Scintilla internal data structures
+/** @file unitTest.cxx
+ ** Unit Tests for Scintilla internal data structures
+ **/
/*
Currently tested: