Skip to content

KickAssembler source code converter to generate DoxyGen interpretable files

License

Notifications You must be signed in to change notification settings

intoinside/KickAssemblerToDoxygen

Repository files navigation

GitHub GitHub Workflow Status GitHub tag (latest by date) Coverage

KickAssemblerToDoxygen

What is this

This Python script provides a simple conversion from KickAssembler source code into C-like format. This new syntax is readable from Doxygen.

Converted files are not meant to contain valid source code.

This script is not perfect and suits well for most of the KickAssembler source code. Feel free to improve it.

Working project

This script is used in many repository derived from c128lib project. A working documentation can be found on framework repository.

How it works

Usage: python KickAssemblerToDoxygen.py <folder-name>

Example: python KickAssemblerToDoxygen.py .\lib

Output file will be automatically created in "output" folder beside folder passed by argument.

Remeber to use slash or backslash correctly.

It works with Python 3.10 and (hopefully) above.

Statements supported

This script removes:

  • .assert
  • .asserterror
  • .filenamespace
  • .importonce
  • .import

After removing all these stuff, it fixes struct declaration.

Next step is to remove initial dot from keywords and then add a semicolon at the end of every label and const declaration.

This sequence is repeated for every file specificated as argument and edited file are saved in output folder.

Breaking change on v1.6

Starting from v1.6, output folder will not be a subfolder of argument but it will be created beside argument folder.

Automation with Github

This plugin can be used with Github Actions, Doxygen and Github Pages. Look at this yml file.

About

KickAssembler source code converter to generate DoxyGen interpretable files

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published