X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXVC.h;h=a860bda8ec289d7e9e27845a80cea914e2948b12;hb=90f7007a2e6c78ffd031e4636ff909ab1bc2ddec;hp=a75dc974536a638de450cdc8788db7c58fade6d9;hpb=ba00acbd6583d33f358a01d42965ea7e0ed9ec54;p=lyx.git diff --git a/src/LyXVC.h b/src/LyXVC.h index a75dc97453..a860bda8ec 100644 --- a/src/LyXVC.h +++ b/src/LyXVC.h @@ -25,7 +25,7 @@ class VCS; class Buffer; /** Version Control for LyX. - This is the class giving the verison control features to LyX. It is + This is the class giving the version control features to LyX. It is intended to support different kinds of version control. The support in LyX is based loosely upon the version control in GNU Emacs, but is not as extensive as that one. See Extended Manual for a simple @@ -43,16 +43,19 @@ public: LyXVC(); /// ~LyXVC(); + /// Is \p fn under version control? + static bool fileInVC(support::FileName const & fn); /** Not a good name perhaps. This function should be called whenever LyX loads a file. This function then checks for a master VC file (for RCS this is *,v or RCS/ *,v ; for CVS this is CVS/Entries and .svn/entries for SVN) if this file or entry is found, the loaded file is assumed to be - under controll by VC, and the appropiate actions is taken. + under control by VC, and the appropiate actions is taken. Returns true if the file is under control by a VCS. */ bool file_found_hook(support::FileName const & fn); - /** This function should be run when a file is requested for loading, + /** Is \p fn under version control? + This function should be run when a file is requested for loading, but it does not exist. This function will then check for a VC master file with the same name (see above function). If this exists the user should be asked if he/her wants to checkout a version for @@ -64,7 +67,7 @@ public: /// void setBuffer(Buffer *); - /// Register the document as an VC file. + /// Register the document as a VC file. bool registrer();