Discussion :

[sitaktif]

Bonjour,
un problème surment très simple me frustre terriblement

Je n'arrive pas à documenter les paramètres de mes fonctions avec ocamldoc.
J'ai essayé plusieurs trucs, notemment :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
 
(* Dans mon fichier .mli *)
(** Cette fonction est un test !
 @param int1 Premier arg                          
 @param int2 Youhouuuu *)                      
val test : int -> int -> unit;;

sachant que dans l'implémentation (le fichier .ml), les deux arguments s'appellent int1 et int2.

... mais pas moyen de faire apparaitre la section "@param" dans la doc (même avec un -all-params, qui liste chaque argument de cette façon : "? : type" dans mon cas...)

si quelqu'un connaît le petit "truc" que je fais de travers... je suis à l'écoute !

Merci,

Romain

[Garulfo]

Le commentaire que tu as mis est pris par le générateur de doc comme le commentaire du module. Conclusion, les étiquettes param sont inutiles et ignorées. De plus, pour que ce soit pris en compte pour ta fonction, tu dois étiquetté ton type.

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
(** Module contenant test *)

(** Commentaire pertinent sur l'utilisation du module 
 @param int1 Premier arg                          
 @param int2 Youhouuuu *)   
val test : int1:int -> int2:int -> unit;;

[sitaktif]

En fait j'avais mis un commentaire plus haut pour le module, donc il le prenait bien pour un commentaire de fonction.
Par contre, merci beaucoup, je ne savais pas qu'il fallait nommer les arguments (ni qu'on pouvait le faire en fait) !
Maintenant ça marche parfaitement !
Au plaisir