[Doxygen-users] Assembly Language

[Relson, D. <dav...@as...>]

I've got an embedded project that's mostly C but has a few assembly
language files.  Using "/** ... */" delimiters the C functions are
easily documented.  However doxygen is not too happy with the assembly
code. =20

I've got a workaround (described below) and am wondering if others have
better solutions ???

Regards,

David

My process involves creating a C skeleton from the assembly code in
several steps, i.e.
  1) converting all the assembly code to comments (by adding a "//"
prefix to each line)
  2) converting all the call opcodes to function calls (of no args)
  3) converting all the labels referenced in step 2 to function
declarations
  4) run doxygen on the resulting code

Here's a small example:

### test.asm (original assembly file) ###
init:
    ... some assembly code
    call main

main:
    ... some assembly code
    call func
    ... more assembly code
    return

func:
    return


### test.asm.c (converted file) ###

/**
*
* This function performs system initialization.
*
* @param <none>
*
* @return <none>
*/
//init:
void init(void)
{
//  ... some assembly code
//  call main
    main( );=20
}

/**
*
* This function is the main program.
*
* @param <none>
*
* @return <none>
*/
//main:
void main(void)
{
//  ... some assembly code
//  call func
    func( );=20
//  ... more assembly code
//  return
    return;=20
}

/**
*
* This function does the work.
*
* @param <none>
*
* @return <none>
*/
//func:
void func(void)
{
//  return
    return;=20
}