changeset 27929:265b386f8b20

maint: Use two spaces between sentences in code comments. * Canvas.cc, Figure.cc, ObjectProxy.cc, documentation.cc, gui-preferences-sc.h, gui-settings.cc, file-editor-tab.cc, file-editor.cc, find-dialog.cc, octave-qscintilla.cc, main-window.cc, qt-interpreter-events.cc, resource-manager.cc, workspace-model.cc, gl2ps-print.cc, graphics.cc, ls-hdf5.cc, urlwrite.cc, __ode15__.cc, gzip.cc, pt-anon-scopes.cc, pt-jit.cc, DASPK.cc, url-transfer.cc: Use two spaces between sentences in code comments.
author Rik <rik@octave.org>
date Fri, 10 Jan 2020 12:10:13 -0800
parents 6804f2feea46
children ea1898178973
files libgui/graphics/Canvas.cc libgui/graphics/Figure.cc libgui/graphics/ObjectProxy.cc libgui/src/documentation.cc libgui/src/gui-preferences-sc.h libgui/src/gui-settings.cc libgui/src/m-editor/file-editor-tab.cc libgui/src/m-editor/file-editor.cc libgui/src/m-editor/find-dialog.cc libgui/src/m-editor/octave-qscintilla.cc libgui/src/main-window.cc libgui/src/qt-interpreter-events.cc libgui/src/resource-manager.cc libgui/src/workspace-model.cc libinterp/corefcn/gl2ps-print.cc libinterp/corefcn/graphics.cc libinterp/corefcn/ls-hdf5.cc libinterp/corefcn/urlwrite.cc libinterp/dldfcn/__ode15__.cc libinterp/dldfcn/gzip.cc libinterp/parse-tree/pt-anon-scopes.cc libinterp/parse-tree/pt-jit.cc liboctave/numeric/DASPK.cc liboctave/util/url-transfer.cc
diffstat 24 files changed, 49 insertions(+), 49 deletions(-) [+]
line wrap: on
line diff
--- a/libgui/graphics/Canvas.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/graphics/Canvas.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -670,7 +670,7 @@
                                       "windowbuttondownfcn",
                                       button_number (event));
 
-              // Execute the "buttondownfcn" of the selected object. If the
+              // Execute the "buttondownfcn" of the selected object.  If the
               // latter is empty then execute the figure "buttondownfcn"
               if (currentObj && ! currentObj.get ("buttondownfcn").isempty ())
                 emit gh_callback_event (currentObj.get_handle (),
--- a/libgui/graphics/Figure.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/graphics/Figure.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -158,7 +158,7 @@
     enableMouseTracking ();
 
     // When this constructor gets called all properties are already
-    // set, even non default. We force "update" here to get things right.
+    // set, even non default.  We force "update" here to get things right.
 
     // Figure title
     update (figure::properties::ID_NUMBERTITLE);
@@ -889,7 +889,7 @@
         fp.set___device_pixel_ratio__ (new_dpr);
 
         // For some obscure reason, changing the __device_pixel_ratio__ property
-        // from the GUI thread does not necessarily trigger a redraw. Force it.
+        // from the GUI thread does not necessarily trigger a redraw.  Force it.
         redraw ();
       }
 #else
--- a/libgui/graphics/ObjectProxy.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/graphics/ObjectProxy.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -134,7 +134,7 @@
     uint8NDArray retval;
 
     // The ObjectProxy is generally ran from the interpreter thread
-    // while the actual Figure (Object) lives in the gui thread. The
+    // while the actual Figure (Object) lives in the gui thread.  The
     // following ensures synchronous execution of the Figure method and
     // allows retrieving a return value.
 
--- a/libgui/src/documentation.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/documentation.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -530,7 +530,7 @@
       m_doc_browser->moveCursor (QTextCursor::Start);
     else
       {
-        // Go to to first occurrence of search text. Going to the end and then
+        // Go to to first occurrence of search text.  Going to the end and then
         // search backwards until the last occurrence ensures the search text
         // is visible in the first line of the visible part of the text.
         m_doc_browser->moveCursor (QTextCursor::End);
--- a/libgui/src/gui-preferences-sc.h	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/gui-preferences-sc.h	Fri Jan 10 12:10:13 2020 -0800
@@ -33,7 +33,7 @@
 // The shortcut's default values are given as QKeySequence for being able
 // to use platform independent standard keys (QKeySequence::StandardKey).
 // However, converting key sequences into QVariants does not seem to be
-// revertible. In addition the related string (which is saved in the
+// revertible.  In addition the related string (which is saved in the
 // preferences file) can not be determined during compile time since the
 // result depends on the platform (at least in case of standard key sequences
 // like, e.g., QKeySequence::Copy)
@@ -124,7 +124,7 @@
 const sc_pref sc_main_news_community_news (sc_main_news + ":community_news", QKeySequence::UnknownKey);
 
 // Tab handling
-// The following shortcuts are moved into a separate tab. The key names
+// The following shortcuts are moved into a separate tab.  The key names
 // are not change for preserving compatibility with older versions
 const QString sc_edit_file ("editor_file");
 const QString sc_edit_file_cl (sc_edit_file + ":close");
--- a/libgui/src/gui-settings.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/gui-settings.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -48,7 +48,7 @@
     QKeySequence key_seq = QKeySequence ();
 
     // Check, which of the elements for the default value in the sc_pref
-    // structure has a valid value and take this as default. If both
+    // structure has a valid value and take this as default.  If both
     // elements are not valid, leave the key sequence empty
     if (pref.def)
       key_seq = QKeySequence (pref.def);
--- a/libgui/src/m-editor/file-editor-tab.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/m-editor/file-editor-tab.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -308,7 +308,7 @@
         (save_dialog == QMessageBox::Save))
       {
         // Ignore close event if file is saved or user cancels
-        // closing this window. In case of saving, tab is closed after
+        // closing this window.  In case of saving, tab is closed after
         // successful saving.
         e->ignore ();
       }
@@ -699,7 +699,7 @@
 
         bool update_apis = false;  // flag, whether update of apis files
 
-        // Get path to prepared api info (cache). Temporarily set the
+        // Get path to prepared api info (cache).  Temporarily set the
         // application name to 'octave' instead of 'GNU Octave' name for
         // not having blanks in the path.
         QString tmp_app_name = QCoreApplication::applicationName ();
@@ -753,7 +753,7 @@
 
             if (octave_functions)
               {
-                // Functions may change frequently. Update the apis data
+                // Functions may change frequently.  Update the apis data
                 // if the file is older than a few minutes preventing from
                 // re-preparing data when the user opens several files.
                 QDateTime apis_time = apis_file.lastModified ();
@@ -1023,7 +1023,7 @@
     if (step_into)
       {
         // Get current first breakpoint and set breakpoint waiting for
-        // the returned line number. Store whether to remove this breakpoint
+        // the returned line number.  Store whether to remove this breakpoint
         // afterwards.
         int first_bp_line
               = m_edit_area->markerFindNext (0, (1 << marker::breakpoint)) + 1;
@@ -2604,7 +2604,7 @@
         if (m_edit_area->isModified ())
           modified = tr ("\n\nWarning: The contents in the editor is modified!");
 
-        // Create a WindowModal message. The file editor tab can't be made
+        // Create a WindowModal message.  The file editor tab can't be made
         // parent because it may be deleted depending upon the response.
         // Instead, change the m_edit_area to read only.
         QMessageBox *msgBox
@@ -2848,7 +2848,7 @@
       {
         // Definitely close the file.
         // Set modified to false to prevent the dialog box when the close event
-        // is posted. If the user cancels the close in this dialog the tab is
+        // is posted.  If the user cancels the close in this dialog the tab is
         // left open with a non-existing file.
         m_edit_area->setModified (false);
         close ();
--- a/libgui/src/m-editor/file-editor.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/m-editor/file-editor.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -497,7 +497,7 @@
 
     // Finally close all the tabs and return indication that we can exit
     // the application or close the editor.
-    // Closing and deleting the tabs makes the editor visible. In case it was
+    // Closing and deleting the tabs makes the editor visible.  In case it was
     // hidden before, this state has to be restored afterwards.
     bool vis = isVisible ();
 
@@ -1123,7 +1123,7 @@
           }
         else
           {
-            // It is a single file. Is it open?
+            // It is a single file.  Is it open?
             file_editor_tab *editor_tab = find_tab_widget (old_names.at (i));
 
             if (editor_tab)
@@ -1166,7 +1166,7 @@
   {
     m_no_focus = true;  // Remember for not focussing editor
 
-    // Loop over all files that have to be reloaded. Start at the end of the
+    // Loop over all files that have to be reloaded.  Start at the end of the
     // list, otherwise the stored indexes are not correct.
     for (int i = m_tmp_closed_files.count () - 1; i >= 0; i--)
       {
@@ -1809,7 +1809,7 @@
     // QStyle *editor_style = QApplication::style ();
 
     // Menu bar: do not set it native, required in macOS and Ubuntu Unity (Qt5)
-    // for a visible menu bar in the editor widget. This property is ignored
+    // for a visible menu bar in the editor widget.  This property is ignored
     // on other platforms.
     m_menu_bar = new QMenuBar (editor_widget);
     m_menu_bar->setNativeMenuBar (false);
@@ -2587,7 +2587,7 @@
         QString abs_path_to_file = old_dir.absoluteFilePath (file_name);
 
         // Test whether the file is located within the directory that will
-        // be removed. For this, two conditions must be met:
+        // be removed.  For this, two conditions must be met:
         // 1. The path of the file rel. to the dir is not equal to the
         //    its absolute one.
         //    If both are equal, then there is no relative path and removed
--- a/libgui/src/m-editor/find-dialog.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/m-editor/find-dialog.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -501,7 +501,7 @@
           }
         else if (! do_forward)
           {
-            // Start from where the cursor is. Fix QScintilla's cursor
+            // Start from where the cursor is.  Fix QScintilla's cursor
             // positioning
             _edit_area->getCursorPosition (&line,&col);
             if (_find_result_available && _edit_area->hasSelectedText ())
--- a/libgui/src/m-editor/octave-qscintilla.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/m-editor/octave-qscintilla.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -191,7 +191,7 @@
 
 #if defined (Q_OS_MAC)
     // Octave interprets Cmd key as Meta whereas Qscintilla interprets it
-    // as Ctrl. We thus invert Meta/Ctrl in Qscintilla's shortcuts list.
+    // as Ctrl.  We thus invert Meta/Ctrl in Qscintilla's shortcuts list.
     QList< QsciCommand * > cmd_list_mac = cmd_set->commands ();
     for (int i = 0; i < cmd_list_mac.length (); i++)
       {
@@ -936,7 +936,7 @@
          catch (const execution_exception& e)
            {
              // Catch errors otherwise the rest of the interpreter
-             // will not be executed (cleaning up). Clean up before.
+             // will not be executed (cleaning up).  Clean up before.
              Frmpath (interp, path);
              emit ctx_menu_run_finished_signal (show_dbg_file,
                                                 tmp_file, tmp_hist, tmp_script);
--- a/libgui/src/main-window.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/main-window.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -178,7 +178,7 @@
 
     m_previous_dock = m_command_window;
 
-    // Set active editor depending on editor window. If the latter is
+    // Set active editor depending on editor window.  If the latter is
     // not initialized (qscintilla not present), use the external editor.
     if (m_editor_window)
       m_active_editor = m_editor_window;
@@ -1248,7 +1248,7 @@
   void main_window::request_open_file (void)
   {
     // Open file isn't a file_editor_tab or editor function since the file
-    // might be opened in an external editor. Hence, functionality is here.
+    // might be opened in an external editor.  Hence, functionality is here.
 
     resource_manager& rmgr = m_octave_qobj.get_resource_manager ();
     gui_settings *settings = rmgr.get_settings ();
@@ -1292,7 +1292,7 @@
   {
     bool ok;
     // Get the name of the new function: Parent of the input dialog is the
-    // editor window or the main window. The latter is chosen, if a custom
+    // editor window or the main window.  The latter is chosen, if a custom
     // editor is used or qscintilla is not available
     QWidget *p = m_editor_window;
     resource_manager& rmgr = m_octave_qobj.get_resource_manager ();
--- a/libgui/src/qt-interpreter-events.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/qt-interpreter-events.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -616,7 +616,7 @@
 
     QString adjusted_value = value;
 
-    // Not all encodings are available. Encodings are uppercase and do
+    // Not all encodings are available.  Encodings are uppercase and do
     // not use CPxxx but IBMxxx or WINDOWS-xxx.
 
     if (key == ed_default_enc.key)
--- a/libgui/src/resource-manager.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/resource-manager.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -419,9 +419,9 @@
     // get the value from the settings file if no current encoding is given
     QString enc = current;
 
-    // Check for valid codec for the default. If this fails, "SYSTEM" (i.e.
+    // Check for valid codec for the default.  If this fails, "SYSTEM" (i.e.
     // codecForLocale) will be chosen.
-    // FIXME: The default is "SYSTEM" on all platforms. So can this fallback
+    // FIXME: The default is "SYSTEM" on all platforms.  So can this fallback
     // logic be removed completely?
     bool default_exists = false;
     if (QTextCodec::codecForName (ed_default_enc.def.toString ().toLatin1 ())
--- a/libgui/src/workspace-model.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libgui/src/workspace-model.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -51,7 +51,7 @@
     m_columnNames.append (tr ("Attribute"));
 
     // Initialize the background and foreground colors of special
-    // classes in the workspace view. The structure is
+    // classes in the workspace view.  The structure is
     // m_storage_class_colors(1,2,...,colors):        background colors
     // m_storage_class_colors(colors+1,...,2*colors): foreground colors
     for (unsigned int i = 0; i < 2*ws_colors_count; i++)
--- a/libinterp/corefcn/gl2ps-print.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/corefcn/gl2ps-print.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -148,7 +148,7 @@
           opts &= ~GL2PS_OCCLUSION_CULL;
           // FIXME: currently the GL2PS_BLEND (which is more an equivalent of
           // GL_ALPHA_TEST than GL_BLEND) is not working on a per primitive
-          // basis. We thus set it once per viewport.
+          // basis.  We thus set it once per viewport.
           gl2psEnable (GL2PS_BLEND);
         }
       else
--- a/libinterp/corefcn/graphics.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/corefcn/graphics.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -5245,7 +5245,7 @@
   Matrix parent_bb = go.get_properties ().get_boundingbox (true);
 
   // FIXME: The layout should be clean at this stage and we should not have to
-  //        update ticks and labels positions here again. See bug #48718.
+  //        update ticks and labels positions here again.  See bug #48718.
   update_ticklength ();
 
   Matrix ext = get_extent (true, true);
@@ -7111,7 +7111,7 @@
             {
               Matrix text_ext = text_props.get_extent_matrix ();
 
-              // The text extent is returned in device pixels. Unscale and
+              // The text extent is returned in device pixels.  Unscale and
               // work with logical pixels
               double dpr = device_pixel_ratio (get___myhandle__ ());
               if (dpr != 1.0)
@@ -8740,7 +8740,7 @@
       else
         {
           // FIXME: get_children_limits is only needed here in order to know
-          // if there are 3D children. Is there a way to avoid this call?
+          // if there are 3D children.  Is there a way to avoid this call?
           get_children_limits (min_val, max_val, min_pos, max_neg, kids, 'z');
 
           xproperties.set_has3Dkids ((max_val - min_val) >
@@ -9724,7 +9724,7 @@
 bool is_coplanar (const Matrix &cov)
 {
   // Accuracy note: this test will also accept single precision input (although
-  // stored in double precision). This is because the error threshold is
+  // stored in double precision).  This is because the error threshold is
   // sqrt(tol) = 1.5e-7.
   double tol = 100 * std::numeric_limits<double>::epsilon ();
   EIG eig (cov, false, false, true);
@@ -9784,7 +9784,7 @@
         }
 
       // Algorithm: Start from 3 points, keep adding points until the point set
-      // is no more in a plane. Record the coplanar point set, then advance
+      // is no more in a plane.  Record the coplanar point set, then advance
       // i_start.
 
       // Prepare 1+3 points for coplanar test.
@@ -12240,7 +12240,7 @@
         busyaction = base_graphics_event::CANCEL;
 
       // The "closerequestfcn" callback must be executed once the figure has
-      // been made current. Let "close" do the job.
+      // been made current.  Let "close" do the job.
       if (cname == "closerequestfcn")
         {
           std::string cmd ("close (gcbf ());");
--- a/libinterp/corefcn/ls-hdf5.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/corefcn/ls-hdf5.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -143,7 +143,7 @@
 hdf5_fstreambase::open_create (const char *name, int mode)
 {
 #if defined (HAVE_HDF5)
-  // Open the HDF5 file NAME. If it does not exist, create the file.
+  // Open the HDF5 file NAME.  If it does not exist, create the file.
 
   std::string fname_str (name);
   std::string ascii_fname_str = octave::sys::get_ASCII_filename (fname_str);
--- a/libinterp/corefcn/urlwrite.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/corefcn/urlwrite.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -340,7 +340,7 @@
         options.Password = value;
 
       if (keys(i) == "ContentReader")
-        // Unimplemented. Only for MATLAB compatibility.
+        // Unimplemented.  Only for MATLAB compatibility.
         options.ContentReader = "";
 
       if (keys(i) == "RequestMethod")
--- a/libinterp/dldfcn/__ode15__.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/dldfcn/__ode15__.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -394,7 +394,7 @@
       {
 #  if defined (HAVE_SUNDIALS_SUNLINSOL_KLU)
         // FIXME : one should not allocate space for a full Jacobian
-        // when using a sparse format. Consider allocating less space
+        // when using a sparse format.  Consider allocating less space
         // then possibly using SUNSparseMatrixReallocate to increase it.
         m_sunJacMatrix = SUNSparseMatrix (m_num, m_num, m_num*m_num, CSC_MAT);
         if (! m_sunJacMatrix)
--- a/libinterp/dldfcn/gzip.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/dldfcn/gzip.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -224,10 +224,10 @@
   //
   //      Note that you cannot specify special gzip header contents (e.g.
   //      a file name or modification date), nor will inflate tell you what
-  //      was in the gzip header. If you need to customize the header or
+  //      was in the gzip header.  If you need to customize the header or
   //      see what's in it, you can use the raw deflate and inflate
   //      operations and the crc32() function and roll your own gzip
-  //      encoding and decoding. Read the gzip RFC 1952 for details of the
+  //      encoding and decoding.  Read the gzip RFC 1952 for details of the
   //      header and trailer format.
   //                                                          zlib FAQ
   //
--- a/libinterp/parse-tree/pt-anon-scopes.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/parse-tree/pt-anon-scopes.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -69,9 +69,9 @@
       expr->accept (*this);
   }
 
-  // The rest of visit_... methods is only for walking the tree. Many of
+  // The rest of visit_... methods is only for walking the tree.  Many of
   // them, in particular all methods for commands, are not applicable to
-  // anonymous functions. Only parts of the tree are walked which could
+  // anonymous functions.  Only parts of the tree are walked which could
   // contain further (nested) anonymous function definitions (so
   // e.g. identifiers and left hand sides of assignments are ignored).
 
--- a/libinterp/parse-tree/pt-jit.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/libinterp/parse-tree/pt-jit.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -2311,7 +2311,7 @@
     bp_table& bptab = __get_bp_table__ ("tree_jit::enabled");
 
     // Ideally, we should only disable JIT if there is a breakpoint in the code
-    // we are about to run. However, we can't figure this out in O(1) time, so
+    // we are about to run.  However, we can't figure this out in O(1) time, so
     // we conservatively check for the existence of any breakpoints.
     return (Vjit_enable && ! bptab.have_breakpoints ()
             && ! Vdebug_on_interrupt && ! Vdebug_on_error);
--- a/liboctave/numeric/DASPK.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/liboctave/numeric/DASPK.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -518,7 +518,7 @@
     case -14: // The Krylov linear system solver could not
               // achieve convergence.
     case -33: // The code has encountered trouble from which it cannot
-              // recover. A message is printed explaining the trouble
+              // recover.  A message is printed explaining the trouble
               // and control is returned to the calling program.  For
               // example, this occurs when invalid input is detected.
       integration_error = true;
--- a/liboctave/util/url-transfer.cc	Fri Jan 10 12:08:07 2020 -0800
+++ b/liboctave/util/url-transfer.cc	Fri Jan 10 12:10:13 2020 -0800
@@ -704,7 +704,7 @@
       SETOPT (CURLOPT_COOKIEFILE, filename.c_str ());
     }
 
-    // Sets the header fields in a transfer. Input should be in the form
+    // Sets the header fields in a transfer.  Input should be in the form
     // of an array of strings with pairs of keys and values together
     void set_header_fields (const Array<std::string>& param)
     {
@@ -790,15 +790,15 @@
           }
       }
 
-      // Unimplemented. Only for MATLAB complatiblity.
+      // Unimplemented.  Only for MATLAB compatibility.
       if (! options.ContentReader.empty ())
         temp = options.ContentReader;
 
-      // Unimplemented. Only for MATLAB complatiblity.
+      // Unimplemented.  Only for MATLAB compatibility.
       if (! options.ArrayFormat.empty ())
         temp = options.ArrayFormat;
 
-      // Unimplemented. Only for MATLAB complatiblity.
+      // Unimplemented.  Only for MATLAB compatibility.
       if (! options.CertificateFilename.empty ())
         temp = options.CertificateFilename;
     }