bergsoe avatar bergsoe committed 11d099a

API doc.

Comments (0)

Files changed (2)

src/PaplIncrEdgeConstraint.mli

 
 type 'a create_t = 'a PaplEdge.t PaplIncrConstraint.create_t
 
-(** {2 Constructors and operations} *)
+(** {2 Constructors} *)
 
 val constrain_by_subdivision :
   'a PaplConstraint.t ->
     The cost of the constraint equals the current length of the subsegments.
 *)
 
+(** {2 Utilities} *)
+
 val constrain_path : 'a create_t -> 'a list -> PaplIncrConstraint.t
 (**
    Prioritized checking of a path.

src/PaplPlanner.mli

   ('a pair_t, 'result) t ->
   ('a region_t pair_t, 'result) t
 
-(** {3 Trajectory planner operations} *)
+(** {2 Trajectory planning} *)
 
 module Trajectory : sig
   val of_metric :
   *)
 end
 
-(** {3 Path planner module types} *)
+(** {2 Path planner module types} *)
 
 module type BIDIR = sig
   type q_t
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.