Work in Progress
Table of Contents
1 Project Journal
1.1 v0.2.0 is ready
2 Project TODO
2.1 TODO [10/16]
[ ]
add a function to show link and targets & detect useless link_target[ ]
search for "export" keyword to annotate documented item[X]
even if complete_link = false, search for target in order to do pretty print (information like struct etc…)[X]
use extracted tag in DocumentedItem[X]
allows tag list "#+tag1, tag2"[X]
add prefix to extra link: ->[X]
finish parsing and code cleaning[ ]
add an option to extract code body[ ]
:RESULT: bug[X]
fix ugly PDF link[X]
detect constructor[X]
for the index, lexico sort: l = L (sort not sensitive to capital)[ ]
support for "@macro function() … end"[X]
support for "macro a_macro"[X]
support for alias/variable "const alias = something"[ ]
add procedure to generate doc withoutob-julia.el
installed
3 Change logs
3.1 v0.1.0 -> v0.2.0
to support poporg (also see QBobWatson/poporg) for comment editing, comment syntax is extended:
- "# +" is processed as "#+"
- "# !" is processed as "#!"
one possible risk is than you must avoid line starting with "!"
You can install poporg from MELPA. Configuration is:
(autoload 'poporg-dwim "poporg" nil t) (global-set-key (kbd "C-c \"") 'poporg-dwim)
- add support for
@enum
- magnified link name if link target is present
- complete refactoring of link engine
- add support for variables
- add support for macros