NaturalDocs / NaturalDocs

Natural Docs source code documentation system
http://www.naturaldocs.org
192 stars 33 forks source link

tcl function parameters #94

Open svennd opened 2 months ago

svennd commented 2 months ago

Is it possible to let NaturalDocs detect Tcl parameters ?

This will only show the printSumProduct function name, but not the parameters x and y :

# proc: printSumProduct
proc printSumProduct {x y} {
    set sum [expr {$x + $y}]
    set prod [expr {$x * $y}]
    puts "sum is $sum, product is $prod"
}

if I wrongly format tcl proc to : () instead of {}

# proc: printSumProduct
proc printSumProduct (x y) {
    set sum [expr {$x + $y}]
    set prod [expr {$x * $y}]
    puts "sum is $sum, product is $prod"
}

It does recognize the parameters (x and y). Sadly tcl is complex in this matter, as also this is valid :

# proc: printSumProduct
proc printSumProduct {x y {z 0}} {
    set sum [expr {$x + $y + $z}]
    set prod [expr {$x * $y * $z}]
    puts "sum is $sum, product is $prod"
}

making matters even more complex I guess.

NaturalDocs commented 1 month ago

Here you go. Try this version: https://www.naturaldocs.org/download/temp/Natural_Docs_temp15.zip

svennd commented 1 month ago

Thanks that works, I gave it a quick try and now it does recognize the parameters, I will check more next week. But this looks great, even the "complex" one :

naturaldocs

Thanks!