Use tool to publish documentation of functions such as doctest.

[gogo2464]

Currently functions are documented with comments. I suggest to use doctstrings and to publish docs online. We could use a tool like doctest for python. I do not know what to use for assembly language.

[dannye]

This is not really appropriate for a project like this.

[gogo2464]

Ok. I understand.

[vulcandth]

@gogo2464 Another bit of info for you. Since pokered is written in assembly, it uses routine's. True functions do not exist, as that comes from higher level programming languages.

[Rangi42]

Public documentation for individual functions makes sense when those functions are part of a public API for a library. That's not the case here: you use and modify the entire disassembly project, and are free to edit or replace anything in it.

The wiki tutorials exist for documenting common upgrades to the project, and (at least in pokecrystal) there are docs for describing how high-level systems in the game work.

[gogo2464]

Well I needed it for my blog : https://gogo2464.github.io/gogo-s-blog/from-0-to-buffer-overflow/episode-1-reverse-engineering-and-exploitation-of-pokemon-red-and-blue/ . In this blog I required to easily find routines names and arguments. Anyway I finished it alone with the comments.