2012-04-20 2 views
3

ocamldoc에서 유형 생성자를 참조하려고합니다.ocamldoc 참조 형식 생성자를 사용할 수 있습니까?

예를 들어

:

type x = Awesome | Boring 

그리고 나중에 우리가 어떤 설명서의 생성자 중 하나를 참조 할 :

(** {!Awesome} is a really great constructor for {!x}. You should definitely use it instead of {!Boring}. *) 

ocamldoc 불평 :

Warning: Element Awesome not found 
Warning: Element Boring not found 

는 방법이 있나요 ocamldoc이 해당 유형에 링크 할 수 있도록 유형 생성자를 참조하려면?

답변

4

형식 생성자로 직접 연결할 수 없습니다. 그러나, 당신은 유형 자체에 연결할 수 있습니다

(** {{!x}Awesome} is a really great constructor for {!x}. *) 

을 더 정확한 뭔가를 원한다면, 당신은 html_of_Ref 방법을 덮어 쓸 수있는 작은 ocamldoc 플러그인을 작성할 수 있습니다.

3

AFAIK 불가능합니다. 이 구문으로 만들 수있는 참조의 종류는 here입니다. 그러나 할 수있는 일은 다음과 같습니다.

(** {{!x}[Awesome]} that will at least bring to {!x} by clicking on it. *) 
관련 문제