Anonymous avatar Anonymous committed dda5775

fix edoc specs so 'make docs' doesn't complain

Comments (0)

Files changed (2)


 start() ->
-%% @spec start(Options) -> Result
-%% @type Options = [Option]
-%% @type Option = {dispatch, Path}|{interval, integer()}
-%% @type Path = string()
+%% @spec start(options()) -> Result
+%% @type options() = [option()]
+%% @type option() = {dispatch, path()}|{interval, integer()}
+%% @type path() = string()
 %% @doc Start the watching, monitoring the file given by the
 %%      'dispatch' path option at the interval given by the
 %%      'interval' option, in milliseconds (or the default path


 %%      re-encodes it as JSON.  The data is expected as query
 %%      parameters for a GET, and request body for a POST.
+%%      ```
 %%      In:  one=two&me=pope
 %%      Out: {"one":"two","me":"pope"}
+%%      '''
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
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.