dxdoc 0.1.0

DxLib documentation index — query, search, and link C++ projects

dxdoc — DxLib Documentation Index

Query, search, and link C++ projects to the official DX Library documentation.

Disclaimer: This is an unofficial, community-made tool. It is not affiliated with, endorsed by, or associated with the DX Library project or its authors. dxdoc only indexes function names and links to the official documentation — it does not reproduce or redistribute any DxLib content.

pip install dxdoc

Usage

CLI

# Look up a function
dxdoc find DrawLine

# Search by pattern
dxdoc search MV1Set*
dxdoc search Draw*

# List categories
dxdoc categories

# List functions in a category
dxdoc list "音利用関数"

# Open documentation in browser
dxdoc open DrawLine

# Show index statistics
dxdoc info

# Scan a C++ project for DxLib calls
dxdoc scan ./my-game/ --context

# Generate a C++ doc header for your project
dxdoc generate ./my-game/ -o dxlib_doc.h

Python API

import dxdoc

# Find a function
f = dxdoc.find("DrawLine")
print(f["declaration"])   # int DrawLine( int x1, int y1, int x2, int y2, unsigned int Color ) ;
print(f["detail_url"])    # https://dxlib.xsrv.jp/function/dxfunc_graph0.html#R2N1

# Search with wildcards
results = dxdoc.search("MV1Set*")

# By category
funcs = dxdoc.by_category("音利用関数")

# Open in browser
dxdoc.open_in_browser("DxLib_Init")

Data

The package embeds dxlib_functions.json — an index of 624 DxLib functions with:

• Function name and category
• Declaration (signature) for 622 functions
• Direct URL to the official documentation
• Platform support (Windows / Android / iOS)

License

MIT — Mehdi.A - the index references the official DxLib website but does not reproduce its content.