Add basic structure

[rbdr/nota.nvim] / lua / notes.lua

-------------------------------------------------------------------------------
-- Tools to deal with notes
-------------------------------------------------------------------------------
-------------------------------------------------------------------------------
-- Public Interface
-------------------------------------------------------------------------------

--- Opens the daily note
-- @param configuration tNotaConfiguration the plugin configuration
function open_daily(configuration)
  error("Not yet implemented")
end

--- Opens the weekly note
-- @param configuration tNotaConfiguration the plugin configuration
function open_weekly(configuration)
  error("Not yet implemented")
end

--- Opens the monthly note
-- @param configuration tNotaConfiguration the plugin configuration
function open_monthly(configuration)
  error("Not yet implemented")
end

--- Opens the seasonal note
-- @param configuration tNotaConfiguration the plugin configuration
function open_seasonal(configuration)
  error("Not yet implemented")
end

--- Opens the yearly note
-- @param configuration tNotaConfiguration the plugin configuration
function open_yearly(configuration)
  error("Not yet implemented")
end

--- Opens an arbitrary note
-- @param configuration tNotaConfiguration the plugin configuration
function open_note(configuration)
  error("Not yet implemented")
end

-------------------------------------------------------------------------------
-- Internal Functions
-------------------------------------------------------------------------------