Skip to content

Markdown to ocamldoc conversion for documentation comments #2602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 6 commits into
base: master
Choose a base branch
from
Draft

Markdown to ocamldoc conversion for documentation comments #2602

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5fd98ab
Doc attributes should use ocaml.text for floating semicolon terminate…
jordwalke Jul 6, 2020
d52a788
Vendor omd
jfrolich Jul 7, 2020
d331c16
try to convert to markdown
jfrolich Jul 9, 2020
df99759
Merge branch 'pr/2601' into markdown-to-ocamldoc
jfrolich Jul 11, 2020
52096ec
embed the original markdown text as the second entry in the list
jfrolich Jul 11, 2020
76f6d9f
only print back markdown
jfrolich Jul 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Doc attributes should use ocaml.text for floating semicolon terminate… 
…d comments
  • Loading branch information
@jordwalke
jordwalke committed Jul 6, 2020
commit 5fd98ab6a8ba6c4ad0eb47b58c3a5fa9969e60e6
2 changes: 1 addition & 1 deletion src/reason-parser/reason_attributes.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ let rec partitionAttributes ?(partDoc=false) ?(allowUncurry=true) attrs : attrib
| ({ attr_name = {txt="ocaml.text"}; _} as doc)::atTl when partDoc = true ->
let partition = partitionAttributes ~partDoc ~allowUncurry atTl in
{partition with docAttrs=doc::partition.docAttrs}
| ({ attr_name = {txt="ocaml.doc"}; _} as doc)::atTl when partDoc = true ->
| ({ attr_name = {txt="ocaml.doc" | "ocaml.text"}; _} as doc)::atTl when partDoc = true ->
let partition = partitionAttributes ~partDoc ~allowUncurry atTl in
{partition with docAttrs=doc::partition.docAttrs}
| ({ attr_name = {txt="reason.raw_literal"}; _} as attr) :: atTl ->
Expand Down
34 changes: 28 additions & 6 deletions src/reason-parser/reason_parser.mly
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,11 @@ module Clflags = Reason_syntax_util.Clflags

*)

let make_floating_doc = function
| {attr_name = {txt = "ocaml.doc"; _} as attr_name; _} as attr ->
{attr with attr_name = {attr_name with txt = "ocaml.text"}}
| attr -> attr

let uncurry_payload ?(name="bs") loc =
{ attr_name = {loc; txt = name};
attr_payload = PStr [];
Expand Down Expand Up @@ -987,6 +992,7 @@ let mkBsObjTypeSugar ~loc ~closed rows =
let doc_loc loc = {txt = "ocaml.doc"; loc = loc}

let doc_attr text loc =
(* Here is where we will convert from markdown to odoc - transform the "text" *)
let open Parsetree in
let exp =
{ pexp_desc = Pexp_constant (Pconst_string(text, None));
Expand Down Expand Up @@ -1728,8 +1734,12 @@ structure_item:
| let_bindings
{ val_of_let_bindings $1 }
) { [$1] }
| located_attributes
{ List.map (fun x -> mkstr ~loc:x.loc (Pstr_attribute x.txt)) $1 }
| located_attributes
{
List.map
(fun x -> mkstr ~loc:x.loc (Pstr_attribute (make_floating_doc x.txt)))
$1
}
;

module_binding_body:
Expand Down Expand Up @@ -1949,7 +1959,9 @@ signature_item:
signature_items:
| as_loc(signature_item) { [mksig ~loc:$1.loc $1.txt] }
| located_attributes
{ List.map (fun x -> mksig ~loc:x.loc (Psig_attribute x.txt)) $1 }
{ List.map
(fun x -> mksig ~loc:x.loc (Psig_attribute (make_floating_doc x.txt)))
$1 }
;

open_declaration:
Expand Down Expand Up @@ -2109,7 +2121,9 @@ class_field:
{ mkcf_attrs (Pcf_extension $2) $1 }
) { [$1] }
| located_attributes
{ List.map (fun x -> mkcf ~loc:x.loc (Pcf_attribute x.txt)) $1 }
{ List.map
(fun x -> mkcf ~loc:x.loc (Pcf_attribute (make_floating_doc x.txt)))
$1 }
;

value:
Expand Down Expand Up @@ -2373,7 +2387,9 @@ class_sig_field:
{ mkctf_attrs (Pctf_extension $2) $1 }
) { [$1] }
| located_attributes
{ List.map (fun x -> mkctf ~loc:x.loc (Pctf_attribute x.txt)) $1 }
{ List.map
(fun x -> mkctf ~loc:x.loc (Pctf_attribute (make_floating_doc x.txt)))
$1 }
;

value_type:
Expand Down Expand Up @@ -4916,7 +4932,13 @@ attribute:
attr_loc = mklocation $symbolstartpos $endpos
}
}
| DOCSTRING { doc_attr $1 (mklocation $symbolstartpos $endpos) }
| DOCSTRING {
(* Here is where we will make another copy of doc_attr but with
* reason.doc/text instead of ocaml.doc/text and _that_ is the one that the
* printer should pay attention to, completely ignoring the ocaml.doc/text
* ones. The ocaml.doc/text ones would only be received by odoc. *)
doc_attr $1 (mklocation $symbolstartpos $endpos)
}
;

(* Inlined to avoid having to deal with buggy $symbolstartpos *)
Expand Down