ocamlspot / dotfile.mli

(***********************************************************************)
(*                                                                     *)
(*                            OCamlSpotter                             *)
(*                                                                     *)
(*                             Jun FURUSE                              *)
(*                                                                     *)
(*   Copyright 2008-2012 Jun Furuse. All rights reserved.              *)
(*   This file is distributed under the terms of the GNU Library       *)
(*   General Public License, with the special exception on linking     *)
(*   described in file LICENSE.                                        *)
(*                                                                     *)
(***********************************************************************)

(* module for .ocamlspot file 

   build_dir: dirname

      Work around for ocamlbuild. If .ocamlspot is placed in a directory $DIR,
      then spot files of source files under $DIR ex. $DIR/subdir/source.ml
      is searched in $DIR/dirname/subdir/.
*)

type t = {
  build_dir : string option;
}

val load : string -> t

val find_and_load : string -> (string * t) option
  (** [find_and_load abspath] searches .ocamlspot file 
      and returns its location (directory) and its contents.
      The search starts from directory [abspath] and if not found
      it checks the parent directory recursively till the root. *)
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.