commit 412ada571d09519be4182afd6a4819c7fa54568f
parent 50805e355aa608d8ed74d956192100e90e2a292d
Author: vx-clutch <[email protected]>
Date: Fri, 24 Oct 2025 21:31:44 -0400
docs did NOT work out
Diffstat:
4 files changed, 0 insertions(+), 193 deletions(-)
diff --git a/build-aux/__gendoc.py b/build-aux/__gendoc.py
@@ -1,116 +0,0 @@
-#!/usr/bin/env python3
-#
-# gendoc vbeta - Generates docs from source comments
-#
-# FEATURES:
-# - Generate comment-based documentation
-#
-# LIMITATIONS:
-# - Platform: Only builds for POSIX systems
-#
-# COMPILATION (Linux - POSIX):
-# ./gendoc.sh
-#
-# LICENSE: BSD-3-Clause
-#
-# Copyright (c) 2025 GCK
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions are met:
-#
-# 1. Redistributions of source code must retain the above copyright notice, this
-# list of conditions and the following disclaimer.
-#
-# 2. Redistributions in binary form must reproduce the above copyright notice,
-# this list of conditions and the following disclaimer in the documentation
-# and/or other materials provided with the distribution.
-#
-# 3. Neither the name of the copyright holder nor the names of its
-# contributors may be used to endorse or promote products derived from
-# this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-#
-
-import sys
-import re
-import os
-
-
-def extract_blocks(source):
- pattern = re.compile(r'/\*-\s*(.*?)\s*-\*/', re.DOTALL)
- blocks = pattern.findall(source)
- results = []
- for block in blocks:
- lines = [line.strip() for line in block.strip().splitlines() if line.strip()]
- if not lines:
- continue
- decl = lines[0]
- desc = " ".join(lines[1:]) if len(lines) > 1 else ""
- results.append([decl, desc])
- return results
-
-
-def search_directory(directory):
- collected = []
- for root, _, files in os.walk(directory):
- for name in files:
- if name.endswith(('.c', '.h')):
- path = os.path.join(root, name)
- with open(path, 'r', encoding='utf-8', errors='ignore') as f:
- collected.extend(extract_blocks(f.read()))
- return collected
-
-
-def main(argv):
- source_dir = argv[1] if len(argv) > 1 else "../src"
- if not os.path.isdir(source_dir):
- print(f"error: '{source_dir}' is not a directory", file=sys.stderr)
- return 1
-
- result = search_directory(source_dir)
- if not result:
- return 0
-
- max_decl_len = max(len(decl) for decl, _ in result)
- output_path = "gendoc.html"
-
- header = (
- "<!DOCTYPE html>\n"
- "<html>\n"
- "<head>\n"
- "<meta charset='utf-8'>\n"
- "<title>Documentation</title>\n"
- "<style>\n"
- "body { font-family: monospace; white-space: pre; }\n"
- "</style>\n"
- "</head>\n"
- "<body>\n<pre><code>\n"
- )
-
- footer = (
- "</code></pre>\n"
- "</body>\n"
- "</html>\n"
- )
-
-
- with open(output_path, 'w', encoding='utf-8') as out:
- out.write(header)
- for decl, desc in result:
- out.write(f"{decl.ljust(max_decl_len)} // {desc}\n")
- out.write(footer)
- return 0
-
-
-if __name__ == "__main__":
- sys.exit(main(sys.argv))
diff --git a/build-aux/gendoc.sh b/build-aux/gendoc.sh
@@ -1,49 +0,0 @@
-#!/bin/sh
-
-# Usage: $0 [options]...
-
-prog_name=$(basename $0)
-tool_version="beta"
-year=2025
-
-fatal() {
- echo "fatal: $*" >&2
- exit 1
-}
-
-run() {
- "$@" || fatal "could not run: $*"
-}
-
-print_help() {
- cat <<EOF
-Usage: $prog_name [options]...
-
- --help print this help and exit.
- --version print version information.
-EOF
-}
-
-print_version() {
- cat <<EOF
-$prog_name $tool_version $(git rev-list --count --all 2>/dev/null || echo 0)
-Copyright (C) $year vx-clutch.
-This is free software: you are free to change and redistribute it.
-There is NO WARRANTY, to the extent permitted by law.
-EOF
-}
-
-old_args="$@"
-
-while [ $# -gt 0 ]; do
- case "$1" in
- --help) print_help; exit 0 ;;
- --version) print_version; exit 0 ;;
- esac
- shift
-done
-
-PYTHON_BIN="$(command -v python3 || command -v python)"
-SCRIPT="__gendoc.py"
-
-exec "$PYTHON_BIN" "$SCRIPT" $old_args
diff --git a/build-aux/test/foo.c b/build-aux/test/foo.c
@@ -1,17 +0,0 @@
-#include <stdio.h>
-
-/*-
-int foo(int x);
-Addes 34 to the provided integer x.
--*/
-
-int foo(int x)
-{
- return x + 34;
-}
-
-int main()
-{
- printf("foo: %d\n", foo(35));
- return 0;
-}
diff --git a/build-aux/test/test.c b/build-aux/test/test.c
@@ -1,11 +0,0 @@
-#include <stdio.h>
-
-/*-
-bool checkit(bool expr);
-checks if an exprssion is true.
--*/
-
-_Bool checkit(_Bool expr)
-{
- return expr;
-}
