Added helper script to live edit & view a doxygen comment block

This uses a new -c option to generate HTML output for a single comment

Author: doxygen

addon/doxycommentview/README.md

@@ -0,0 +1,37 @@
+# Viewer for Doxygen style comments
+
+## Contents
+
+The directory contains an index.html page and a python3 helper script.
+The script can be used to start a local web server that can do life rendering of doxygen comments.
+
+Similar to e.g. https://markdownlivepreview.com/ but using doxygen as render engine.
+
+## To prepare the server
+
+Place a doxygen.css in the same directory as the doxycommentview.py script.
+
+This file can be generated running
+
+    doxygen -w html /tmp/header.html /tmp/footer.html doxygen.css path/to/Doxyfile
+
+or, alternatively, copied from an existing HTML output directory generated by doxygen.
+
+## To run the server invoke:
+
+    python3 doxycommentview.py --doxyfile /path/to/Doxyfile
+
+The relevant settings, such as alias definitions, will be taken from the Doxyfile.
+
+If desired you can set the port for the webserver using `--port` and
+point to the location of the doxygen binary using `--doxygen`
+
+Once the server is started, point your browser to the index page
+
+    firefox http://localhost:8000/index.html
+
+You should see a panel to enter text on the left hand side and the output
+rendered by doxygen on the right hand side of the page.
+
+You can copy and paste the contents of this README.md file to test it quickly.
+

addon/doxycommentview/doxycommentview.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+#
+# python3 helper script to start a web server that can do life rendering of doxygen comments.
+#
+# Copyright (C) 1997-2024 by Dimitri van Heesch.
+#
+# Permission to use, copy, modify, and distribute this software and its
+# documentation under the terms of the GNU General Public License is hereby
+# granted. No representations are made about the suitability of this software
+# for any purpose. It is provided "as is" without express or implied warranty.
+# See the GNU General Public License for more details.
+#
+# Documents produced by Doxygen are derivative works derived from the
+# input used in their production; they are not affected by this license.
+#
+
+import http.server
+import socketserver
+import json
+import subprocess
+import argparse
+import signal
+import threading
+
+def main():
+    # Set up argument parser
+    parser = argparse.ArgumentParser(description="Runs the doxygen comment viewer HTTP server.")
+    parser.add_argument('--port', type=int, default=8000, help='Port number to run the server on')
+    parser.add_argument('--doxygen', type=str, default='doxygen', help='Path to doxygen executable')
+    parser.add_argument('--doxyfile', type=str, default='Doxyfile', help='Path to Doxyfile to use')
+    args = parser.parse_args()
+
+    PORT = args.port
+    DOXYGEN = args.doxygen
+    DOXYFILE = args.doxyfile
+
+    class RequestHandler(http.server.SimpleHTTPRequestHandler):
+        def do_POST(self):
+            if self.path == '/process':
+                content_length = int(self.headers['Content-Length'])
+                post_data = self.rfile.read(content_length)
+                data = json.loads(post_data)
+                input_text = data['input']
+
+                # Run doxygen in single comment mode, reading from stdin and writing to stdout
+                result = subprocess.run([DOXYGEN, '-c', '-', DOXYFILE], \
+                                        input=input_text, capture_output=True, text=True)
+
+                # Insert CSS link tag into the HTML output
+                self.send_response(200)
+                self.send_header('Content-type', 'text/html')
+                self.end_headers()
+                self.wfile.write(result.stdout.encode())
+
+    httpd = socketserver.TCPServer(("", PORT), RequestHandler)
+
+    def signal_handler(sig, frame):
+        print('Shutting down the web server...')
+        threading.Thread(target=httpd.shutdown).start()
+
+    signal.signal(signal.SIGINT, signal_handler)
+
+    print("Running web server on port", PORT)
+    httpd.serve_forever()
+
+if __name__ == '__main__':
+    main()

addon/doxycommentview/index.html

@@ -0,0 +1,69 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Doxygen comment viewer</title>
+    <link rel="stylesheet" type="text/css" href="/doxygen.css"/>
+    <style>
+        body {
+            margin: 0;
+            padding: 0;
+            display: flex;
+            height: 100vh;
+        }
+        .panel {
+            width: 50%;
+            padding: 20px;
+            box-sizing: border-box;
+        }
+        #input {
+            width: 100%;
+            height: 100%;
+            box-sizing: border-box;
+            resize: none; /* Prevent resizing */
+        }
+        #output {
+            border-left: 1px solid #ccc;
+            overflow: auto;
+        }
+    </style>
+</head>
+<body>
+    <div class="panel">
+        <textarea id="input"></textarea>
+    </div>
+    <div class="panel" id="output">
+        <!-- Processed output will appear here -->
+    </div>
+    <script>
+        function processInput() {
+            const input = document.getElementById('input').value;
+            localStorage.setItem('userInput', input);
+            fetch('/process', {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                },
+                body: JSON.stringify({ input: input }),
+            })
+            .then(response => response.text())
+            .then(result => {
+                document.getElementById('output').innerHTML = result;
+            });
+        }
+
+        document.getElementById('input').addEventListener('input', () => {
+            processInput();
+        });
+
+        // Load previously saved input from local storage
+        window.onload = () => {
+            const savedInput = localStorage.getItem('userInput');
+            if (savedInput) {
+                document.getElementById('input').value = savedInput;
+                processInput();
+            }
+        };
+    </script>
+</body>
+</html>

src/CMakeLists.txt

@@ -310,6 +310,7 @@ add_library(doxymain STATIC
     rtfstyle.cpp
     searchindex.cpp
     searchindex_js.cpp
+    singlecomment.cpp
     sitemap.cpp
     sqlite3gen.cpp
     stlsupport.cpp