1
0
Fork 0
forked from fun/fun

Added Doxigen configuration file Doxyfile to project root. No code changes. (0.41.5)

This commit is contained in:
Johannes Findeisen 2026-05-07 00:31:46 +02:00
commit 7fd6445cd2
8 changed files with 3062 additions and 64 deletions

3
.gitignore vendored
View file

@ -1,5 +1,4 @@
CMakeCache.txt CMakeCache.txt
Doxyfile
.* .*
!.clang-format !.clang-format
!.clang-tidy !.clang-tidy
@ -7,6 +6,7 @@ Doxyfile
!.gitignore !.gitignore
!.github !.github
!.gitkeep !.gitkeep
!api/.gitkeep
.venv .venv
api/ api/
build/* build/*
@ -29,5 +29,4 @@ src/rust/target
tmp* tmp*
web/_cache/* web/_cache/*
web/_site/* web/_site/*
web/api/
web/Gemfile.lock web/Gemfile.lock

View file

@ -14,9 +14,9 @@ include(${CMAKE_SOURCE_DIR}/cmake/Targets.cmake)
# --- Always show key build toggles --- # --- Always show key build toggles ---
# Normalize to ENABLED/DISABLED like the "Fun extension summary" # Normalize to ENABLED/DISABLED like the "Fun extension summary"
if(FUN_DEBUG) if(FUN_DEBUG)
set(_FUN_DEBUG_STATE "ENABLED") set(_FUN_DEBUG_STATE "ENABLED")
else() else()
set(_FUN_DEBUG_STATE "DISABLED") set(_FUN_DEBUG_STATE "DISABLED")
endif() endif()
if(FUN_USE_MUSL) if(FUN_USE_MUSL)
@ -38,9 +38,9 @@ else()
endif() endif()
if(FUN_BUILD_DOCS) if(FUN_BUILD_DOCS)
set(_FUN_BUILD_DOCS "ENABLED") set(_FUN_BUILD_DOCS "ENABLED")
else() else()
set(_FUN_BUILD_DOCS "DISABLED") set(_FUN_BUILD_DOCS "DISABLED")
endif() endif()
message(STATUS "==== Fun build options ====") message(STATUS "==== Fun build options ====")

3050
Doxyfile Normal file

File diff suppressed because it is too large Load diff

View file

@ -1,53 +0,0 @@
## Doxygen configuration for the "fun" project (processed by CMake)
# This file is configured by CMake's configure_file(@ONLY).
# --- Project ---
PROJECT_NAME = "Fun"
PROJECT_NUMBER = "@FUN_DOCS_VERSION@"
# Optional project logo (relative or absolute path). Leave empty if not found.
PROJECT_LOGO = "@FUN_DOCS_LOGO@"
# --- Output ---
OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@/docs"
CREATE_SUBDIRS = NO
GENERATE_HTML = YES
HTML_OUTPUT = html
GENERATE_LATEX = NO
# --- Input ---
INPUT = "@CMAKE_SOURCE_DIR@/src"
RECURSIVE = YES
FILE_PATTERNS = *.h *.hpp *.c *.cc *.cpp
# --- Extraction policy ---
# Default to public/protected only to reduce noise; flip to YES if you want internals.
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_METHODS = YES
OPTIMIZE_OUTPUT_FOR_C = YES
# --- Paths shown in docs ---
FULL_PATH_NAMES = NO
STRIP_FROM_PATH = "@CMAKE_SOURCE_DIR@"
# --- Source browsing ---
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
GENERATE_TREEVIEW = YES
# --- Diagrams (Graphviz) ---
HAVE_DOT = @HAVE_DOT@
CLASS_DIAGRAMS = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
DOT_IMAGE_FORMAT = svg
# --- Warnings / noise ---
QUIET = YES
WARN_IF_UNDOCUMENTED = NO
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO

0
api/.gitkeep Normal file
View file

View file

@ -3,8 +3,6 @@ all:
build: build:
bundle exec jekyll b --incremental bundle exec jekyll b --incremental
rm -rf _site/api
cp -Rv ../api/html ./_site/api
clean: clean:
rm -rf _site/* rm -rf _site/*
@ -69,6 +67,7 @@ runreload:
sync: sync:
rsync -avr --delete --delete-excluded ./_site/ fun-lang.xyz:/var/www/fun-lang.xyz/www/htdocs/ rsync -avr --delete --delete-excluded ./_site/ fun-lang.xyz:/var/www/fun-lang.xyz/www/htdocs/
rsync -avr --delete --delete-excluded ../api/html/ fun-lang.xyz:/var/www/fun-lang.xyz/api/htdocs/
#ssh a.xw3.org 'cd /var/www/fun-lang.xyz/www/lib/ && git pull' #ssh a.xw3.org 'cd /var/www/fun-lang.xyz/www/lib/ && git pull'
#ssh a.xw3.org 'cd /var/www/fun-lang.xyz/www/htdocs/cgi/bin/ && gcc index.c -o index' #ssh a.xw3.org 'cd /var/www/fun-lang.xyz/www/htdocs/cgi/bin/ && gcc index.c -o index'

View file

@ -8,6 +8,7 @@ noToc: false
title: Announcing the Fun API Documentation title: Announcing the Fun API Documentation
description: A new API documentation hub is now available at fun-lang.xyz/api to explore the Fun VM internals and get contributors started faster. description: A new API documentation hub is now available at fun-lang.xyz/api to explore the Fun VM internals and get contributors started faster.
date: 2026-05-01 date: 2026-05-01
date_updated: 2026-05-06
categories: categories:
- news - news
- docs - docs
@ -23,7 +24,7 @@ tags:
We are excited to announce that the official Fun API documentation is now live at: We are excited to announce that the official Fun API documentation is now live at:
- [https://fun-lang.xyz/api/](https://fun-lang.xyz/api/) - [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"}
This new documentation hub is intended to make it easier to understand the internals of the Fun Virtual Machine (VM) and related components. It serves as a central entry point for participants, contributors, and anyone interested in building on top of Fun. This new documentation hub is intended to make it easier to understand the internals of the Fun Virtual Machine (VM) and related components. It serves as a central entry point for participants, contributors, and anyone interested in building on top of Fun.
@ -44,7 +45,7 @@ This is actually a work in progress, and we are continuously improving and expan
### How to get involved ### How to get involved
- Browse the API docs at [https://fun-lang.xyz/api/](https://fun-lang.xyz/api/) and send feedback. - Browse the API docs at [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"} and send feedback.
- Open issues and ideas in our Git repository: [https://git.xw3.org/fun/fun](https://git.xw3.org/fun/fun){:class="git"}. - Open issues and ideas in our Git repository: [https://git.xw3.org/fun/fun](https://git.xw3.org/fun/fun){:class="git"}.
- Join the discussion: [https://fun-lang.xyz/community/](https://fun-lang.xyz/community/). - Join the discussion: [https://fun-lang.xyz/community/](https://fun-lang.xyz/community/).
- Reach out directly: [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"}. - Reach out directly: [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"}.
@ -54,3 +55,5 @@ This is just the beginning — we will keep iterating on structure, coverage, an
Happy hacking! Happy hacking!
Johannes Findeisen (hanez) — [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"} Johannes Findeisen (hanez) — [hanez@fun-lang.xyz](mailto:hanez@fun-lang.xyz){:class="mail"}
UPDATE: The api documentation moved to [https://api.fun-lang.xyz/](https://api.fun-lang.xyz/){:class="ext"}.

View file

@ -21,7 +21,7 @@ This file serves as an index of the documents in this directory. Links are relat
- [Handbook](./handbook/) - Comprehensive handbook for the Fun language and VM: install/build, configuration flags, usage, and full feature overview. - [Handbook](./handbook/) - Comprehensive handbook for the Fun language and VM: install/build, configuration flags, usage, and full feature overview.
- [REPL](./repl/) - REPL user guide: how to build/launch, editing and history, completions, REPL-on-error, and tips. - [REPL](./repl/) - REPL user guide: how to build/launch, editing and history, completions, REPL-on-error, and tips.
- [API](../api/) - API documentation for the Fun language and VM. - [API](https://api.fun-lang.xyz/){:class="ext"} - API documentation for the Fun language and VM.
- Specification - Specification
- [v0.4](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.4/){:class="git"} - [v0.4](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.4/){:class="git"}
- [v0.3](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.3/){:class="git"} - [v0.3](https://git.xw3.org/fun/fun/src/branch/main/spec/v0.3/){:class="git"}