Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0006021OCamlOCamldocpublic2013-05-25 19:392013-07-12 16:58
Reportergasche 
Assigned Toguesdon 
PrioritynormalSeveritytextReproducibilityN/A
StatusresolvedResolutionfixed 
PlatformOSOS Version
Product Version 
Target Version4.01.0+devFixed in Version4.01.0+dev 
Summary0006021: [patch] document the "const:" and "recfield:" cross-reference syntaxes
DescriptionThe following StackOverflow question "Reference a type constructor in ocamldoc"
  http://stackoverflow.com/questions/16743444/referencing-a-type-constructor-in-ocamldoc/16743728 [^]
prompted me to discover the existence of the undocumented "const:" and "recfield:" syntaxes for cross-referencing, and more importantly the non-obvious typename.constname structure of the reference.

The attached patch to the OCamldoc manual expands on the present description of the cross-reference syntax {!foo}, detailing these additional fields and their expected reference syntax.
TagsNo tags attached.
Attached Filestxt file icon ocamldoc-document-crossref.txt [^] (3,164 bytes) 2013-05-25 19:39 [Show Content]

- Relationships

-  Notes
(0009766)
doligez (administrator)
2013-07-12 16:58

Patch reviewed and applied (rev 13892).

- Issue History
Date Modified Username Field Change
2013-05-25 19:39 gasche New Issue
2013-05-25 19:39 gasche Status new => assigned
2013-05-25 19:39 gasche Assigned To => guesdon
2013-05-25 19:39 gasche File Added: ocamldoc-document-crossref.txt
2013-07-12 16:58 doligez Note Added: 0009766
2013-07-12 16:58 doligez Status assigned => resolved
2013-07-12 16:58 doligez Resolution open => fixed
2013-07-12 16:58 doligez Fixed in Version => 4.01.0+dev
2013-07-12 16:58 doligez Target Version => 4.01.0+dev


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker