Summary:
This diff enables parsing and auto-formatting documentation
comments (aka docstrings).
I have looked at this entire diff and manually made some changes to
improve the formatting. In some cases it looked like it would take too
much time, or benefit from someone more familiar with the code doing
it, and I instead disabled auto-formatting docstrings in those files.
Also, there are some source files where the docstrings are invalid,
and some where the structure detected by the parser appears not to
match what was intended. Auto-formatting has been disabled for these
files.
Reviewed By: ezgicicek
Differential Revision: D18755888
fbshipit-source-id: 68d72465d
master
Josh Berdine5 years agocommitted byFacebook Github Bot
(** extract the access paths that occur in [exp], resolving identifiers using [f_resolve_id]. don't include index expressions in array accesses if [include_array_indexes] is false *)
(** extract the access paths that occur in [exp], resolving identifiers using [f_resolve_id]. don't
(** Stacked abstract domain: tagged union of [Below] and [Above] domains where all elements of [Below] are strictly smaller than elements of [Above] *)
(** Stacked abstract domain: tagged union of [Below] and [Above] domains where all elements of
(** Return true if applying the given predicate to an override of [procname] (including [procname] itself when [check_current_type] is true, which it is by default) returns true. *)
(** Return true if applying the given predicate to an override of [procname] (including [procname]
(** EF phi <=> there exits a a path from the current node with a descendant where phi hold *)
|AGoftransitionsoption*t(** AG phi <=> for all discendant of the current node phi hold *)
|EGoftransitionsoption*t
(** EG phi <=> there exists a path (of descendants) from the current node where phi hold at each node of the path *)
(** EG phi <=> there exists a path (of descendants) from the current node where phi hold at
eachnodeofthepath*)
|AUoftransitionsoption*t*t
(** AU(phi1, phi2) <=> for all paths from the current node phi1 holds in every node until ph2 holds *)
(** AU(phi1, phi2) <=> for all paths from the current node phi1 holds in every node until ph2
holds*)
|EUoftransitionsoption*t*t
(** EU(phi1, phi2) <=> there exists a path from the current node such that phi1 holds until phi2 holds *)
(** EU(phi1, phi2) <=> there exists a path from the current node such that phi1 holds until
phi2holds*)
|EHofALVar.alexplist*t
(** EH[classes]phi <=> there exists a node defining a super class in the hierarchy of the class defined by the current node (if any) where phi holds *)
(** EH[classes]phi <=> there exists a node defining a super class in the hierarchy of the
(** [mk_symbol_opt] is similar to [mk_symbol] but defaults to [None]. If [mk_reset] is false then do not create an additional --[long]-reset option to reset the value of the option to [None]. *)
(** [mk_symbol_opt] is similar to [mk_symbol] but defaults to [None]. If [mk_reset] is false then do
(** Verify we have a json list of strings and return the corresponding ocaml string list. Otherwise die with a message including src. *)
(** Verify we have a json list of strings and return the corresponding ocaml string list. Otherwise
diewithamessageincludingsrc.*)
valyojson_lookup:
(string,Yojson.Basic.t)List.Assoc.t
@ -143,7 +147,9 @@ val yojson_lookup :
->f:(Yojson.Basic.t->src:string->'a)
->default:'a
->'a
(** Lookup a json value on an assoc list. If not present, returns default. Otherwise returns (f json_value ~src) where src has element name appended. f is typically one of the above _of_yojson functions. *)
(** Lookup a json value on an assoc list. If not present, returns default. Otherwise returns (f
Josh Berdine
5 years ago
committed by
Facebook Github Bot