Flag: Tornado! Hurricane!

IDA Plugins: IDADoc

File Information
Category Open Source # Downloads Version
IDA Plugins Yes 3,019 1.00

Download from OpenRCE
MD5 Sum: 4C1F5A0E9091B1BBE02D5A811332F687

Last updated on Feb 13, 2006.

Author Information
Username Name E-Mail URL
Sebastian Porst webmasterthe-interwebcom

Description Similar to JavaDoc or Doxygen, IDADoc extracts comments from all parts of an IDA database where it is assumed useful information about functions is stored. Here's what IDADoc can do already:

- Supports function comments
- Supports parameter definitions
- Supports return value definitions
- Picks up specially formed anterior lines inside functions to create detailed descriptions of functions
- Creates a list of code references to functions
- Support for special character replacement (like replacing all \ characters with $\backslash$ in latex)

Right now idadoc supports two output formats, HTML and latex. Theoretically a lot more ASCII formats are supported though because idadoc draws all formatting information from so called template files (there's zero formatting information in the plugin binary). It's just that I only made two template files, html.tpl and latex.tpl, so far. If you don't like the layout of the HTML/latex output files or you want completely new output formats you can just create your own template files and use them instead of the default ones.

Using idadoc is pretty simple. Open IDA and annotate a disassembled file according to the idadoc formatting rules. Then choose the idadoc plugin from the plugin menu. A file dialog will pop up asking you for a template file (*.tpl). Once you selected a template file the output is created and idadoc asks you for the name of the output file.

There are 30,997 total registered users.


Recently Created Topics
let 'IDAPython' impo...
Sep/24
set 'IDAPython' as t...
Sep/24
GuessType return une...
Sep/20
About retrieving the...
Sep/07
How to find specific...
Aug/15
How to get data depe...
Jul/07
Identify RVA data in...
May/06
Immunity Debugger Re...
Aug/03
Question about memor...
Dec/12
How can i find conne...
Nov/27


Recent Forum Posts
How to find specific...
hackgreti
Problem with ollydbg
sh3dow
How can I write olly...
sh3dow
New LoadMAP plugin v...
mefisto...
Intel pin in loaded ...
djnemo
OOP_RE tool available?
Bl4ckm4n
OOP_RE tool available?
van7hu
Should binaries be n...
Kolisar
Problem with ollydbg
nullx42
!findtrampoline Immu...
skycrack


Recent Blog Entries
nieo
Mar/22
Android Application Reversing

halsten
Mar/14
Breaking IonCUBE VM

oleavr
Oct/24
Anatomy of a code tracer

hasherezade
Sep/24
IAT Patcher - new tool for ...

oleavr
Aug/27
CryptoShark: code tracer ba...

More ...


Recent Blog Comments
nieo on:
Mar/22
IAT Patcher - new tool for ...

djnemo on:
Nov/17
Kernel debugger vs user mod...

acel on:
Nov/14
Kernel debugger vs user mod...

pedram on:
Dec/21
frida.github.io: scriptable...

capadleman on:
Jun/19
Using NtCreateThreadEx for ...

More ...


Imagery
SoySauce Blueprint
Jun 6, 2008

[+] expand

View Gallery (11) / Submit