Question on DOxygen use

[wallyg]

I have looked into and plan to use DOxygen for documenting my next project.

I was wondering if there were any special things I need to consider or do because FB is not in the list of languages that DOxygen talks about? Any suggestions or comments would be welcome on getting started. Or any gotchas I need to consider?

Thanks in advance for any help.

Wallly

[marcov]

Since such applications are based on a language parser to retrieve function and type signatures from source, that will be difficult without a supported parser.

[wallyg]

Thank you for your response. Any suggestions for a post processor to pull documentation embedded in source code into a user manual?

Wally

[paul doe]

Thank you for your response. Any suggestions for a post processor to pull documentation embedded in source code into a user manual?

Certainly: code it.

That depends on which format is the documentation written in. You can do something akin to .Net languages, with XML comments:

Code: Select all

  ''' <summary>
  ''' Snaps the specified vertex to the block grid.
  ''' </summary>
  ''' <param name="v">The vertex to snap to grid, expressed in world coordinates.</param>
  ''' <returns></returns>
  Protected Function SnapToGrid(v As Vec2) As Vec2
    Dim hbsx As Single = IIf(v.x >= 0, GridSize * 0.5, -GridSize * 0.5)
    Dim hbsy As Single = IIf(v.y >= 0, GridSize * 0.5, -GridSize * 0.5)

    Return (New Vec2((v.x + hbsx) \ GridSize, (v.y + hbsy) \ GridSize) * GridSize)
  End Function

That way, you pass the source code to the preparser, which can then extract the needed info for any symbols you document (XML is easy to parse; there are several parsers available in this forum).

[marcov]

Thank you for your response. Any suggestions for a post processor to pull documentation embedded in source code into a user manual?

I've no idea if that is even possible. Anyway, these are questions for Doxygen, though they might benefit from a formal FB dialect spec.

Maybe, very maybe, there is some shortcut via LSP (the per language bit of Visual Studio Code). But I personally I'm not too deep into those.

[wallyg]

Thanks, Paul. I will certainly look into this as a possibility.

[St_W]

You may have a look at "fbdoc": https://github.com/DTJF/fbdoc