Ocamldoc генерирует документацию для функций? - PullRequest
Новая
       18

Ocamldoc генерирует документацию для функций?

1 голос
/ 11 мая 2019

Я использую ocamldoc для генерации документации моей программы.Мой код пока не очень большой, у меня есть только одна функция, но когда я открываю HTML, документация по функциям не появляется ни в одном из файлов, созданных ocamldoc.

Я использую ocamldoc -all-params arbol\ binario.ml для генерацииHTML

Я прочитал документацию по ocamldoc и использовал флаг -all-params, но он тоже не работал.Также я создал простую нерекурсивную функцию, но это тот же вывод. 

(** @author Roldan Rivera Luis Ricardo
@author Foo*)

(**Este modulo contiene la implementacion de una arbol binario 
de busqueda BST (acrónimo del inglés Binary Search Tree)
con sus funciones basicas.

{b funciones}
- {! Crear}
- {! Insertar}
- {! Buscar}
- {! Recorrer}*)

(** Tipo de dato llamado Tree, la notacion 'a (alfa) indica que es un
tipo de dato polimorfico, es decir que puede soportar
cualquier tipo de dato. *)

type 'a tree =
    | Branch of 'a * 'a tree * 'a tree (** Un elemento * sub-arbol izquierdo * sub-arbol derecho *)
    | Leaf (** El fin de una rama, significa que ya no hay mas sub-arboles, equivalente al Nil *)

(** Busca el dato deseado en el arbol
 @param tree Arbol donde se va a realizar la busqueda
 @param x El valor a buscar
 @return None Si no se encuentra el dato en el arbol*)
let rec buscar tree x =
match tree with
| Leaf -> None
| Branch(k,left,right) ->
    if k = x then Some x
    else if x < k then buscar left x
    else buscar right x

1 Ответ

0 голосов
/ 12 мая 2019

Вы забыли уточнить html-бэкэнд (также не следует указывать пробел в имени модуля)?

При запуске ocamldoc с 

ocamldoc -html -all-params filename.ml

должна быть напечатана следующая документация для функции:

<pre><span id="VALbuscar"><span class="keyword">val</span> buscar</span> : <code class="type">'a <a href="A.html#TYPEtree">tree</a> -> 'a -> 'a option

Busca el dato deseado en el arbol

Возвращает Нет Si no se encuentra el dato en el arbol Параметры: дерево : х :
...