Skip to content

search_path.m

Basic Information

  SYNTAX:  results = search_path(string,path_depth,search_depth)

  PURPOSE:  String search of the matlabpath for documentation about a function,
    or model, or whatever, whose documentation contains the search string.
    (See also lookfor, whatfunction)

  INPUT:
    string       = string to search for
    path_depth   = one of the following (optional argument):
            - integer specifying how many directories in
            path to search
            - string specifying last directory to search
                (e.g. 'GAcontrol')
            - 'all', i.e. search all directories (default)
    search_depth = 'shallow' or 'deep' (optional, default='shallow')
           'shallow' = look at Contents.m files only
           'deep'    = search both Contents.m files and all m-files
                (deep search takes awhile)

  OUTPUT:
    results = string containing documentation lines where strings matched
        and files where found

  RESTRICTIONS:  Bug in MATLAB restricts when the 'deep' option will work.
    Uses the "unix" command to find m-files in a directory and sometimes
    this command doesn't work.

Dependencies