Skip to content

Commit

Permalink
created doxygen comments for the dir_ops
Browse files Browse the repository at this point in the history
  • Loading branch information
teju85 committed Oct 27, 2020
1 parent a94d175 commit ab7a44b
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ Given below are the groups of commands that are currently supported:
3. @ref cursor_ops
4. @ref editor_ops
5. @ref calc_ops
6. @ref dir_ops
45 changes: 45 additions & 0 deletions src/extensions/dir/ops.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,20 @@ namespace teditor {
namespace dir {
namespace ops {

/**
* @page dir_ops Operations supported under dir-mode
* All operations supported under `dir-mode`.
*
* @tableofcontents
*/

/**
* @page dir_ops
* @section dirmode-open-file
* Open the file under the cursor in a new Buffer.
*
* @note Available since v0.1.0
*/
DEF_CMD(
OpenFile, "dirmode-open-file", DEF_OP() {
auto& buf = ed.getBuff();
Expand All @@ -23,6 +37,13 @@ DEF_CMD(
},
DEF_HELP() { return "Open the file under the cursor in a new buffer."; });

/**
* @page dir_ops
* @section dirmode-open-special-file
* Open the file using the program specified in the Option `startProg`.
*
* @note Available since v0.1.0
*/
DEF_CMD(
OpenSpecialFile, "dirmode-open-special-file", DEF_OP() {
auto& buf = ed.getBuff();
Expand All @@ -39,6 +60,14 @@ DEF_CMD(
},
DEF_HELP() { return "Open the file using the <startProg>."; });

/**
* @page dir_ops
* @section dirmode-copy-file
* Copy the file under the cursor by prompting for the name of the new file.
* Currently, copying of directories is NOT supported.
*
* @note Available since v0.1.0
*/
DEF_CMD(
CopyFile, "dirmode-copy-file", DEF_OP() {
auto& buf = ed.getBuff();
Expand All @@ -62,6 +91,14 @@ DEF_CMD(
" the new file. Currently, copying directories is unsupported!";
});

/**
* @page dir_ops
* @section dirmode-rename-file
* Rename the file under the cursor by prompting for its new name. This will
* reload the buffer at the end to reflect the changes.
*
* @note Available since v0.1.0
*/
DEF_CMD(
RenameFile, "dirmode-rename-file", DEF_OP() {
auto& buf = ed.getBuff();
Expand All @@ -83,6 +120,14 @@ DEF_CMD(
" buffer at the end to reflect the changes.";
});

/**
* @page dir_ops
* @section dirmode-delete-file
* Delete the file under the cursor. This will reload the buffer at the end to
* reflect the changes.
*
* @note Available since v0.1.0
*/
DEF_CMD(
DeleteFile, "dirmode-delete-file", DEF_OP() {
auto& buf = ed.getBuff();
Expand Down

0 comments on commit ab7a44b

Please sign in to comment.