Based on work by Ilmari Lauhakangas, The Document Foundation Wiki user RaducuG and others. This page was last edited 13:25:20, by Samuel Mehrbrodt.If you want to preview the API documentation locally, build the documentation with make odk, then open the file workdir/CustomTarget/odk/docs/idl/ref/index.html with a browser. Avoid documenting what is trivial (for example, stating in the documentation that a constructor is a constructor is pointless).Try to document anything non-trivial (special requirements for the call, side-effects, etc.).The documentation is written in the source code (header files usually) and so it can be also easily read there.This function does not do anything the value 42 To restore the SwCursor object passed to the constructor to the saved state.įooFirst, ///< first value of the unused enumįooSecond /**< second value of the unused enum */ Note: The destructor only discards the saved value. * Saves the state of the given SwCursor object. It is possible to stack several SwCrsrSaveState objects. To actually restore cursor state to the saved state. - paired with text between these tags is treated as C++ codeĪ helper class to save cursor state (position).Ĭreate SwCrsrSaveState object to save current state, use SwCursor::RestoreSavePos().- a one-line description of the return value of the function.- a one-line description of the given argument of the function.- marks the first version in which the object has appeared.- adds a reference to the given object (related classes, functions, types etc.< appended).Įach documentation comment typically starts with one line that gives a brief description of the object in one sentence,įollowed by an empty line and a full multi-line description, and ends with a list of special tags that start with most commonly used tags are: If they are to be placed after the object (such as when documenting enum members), they start with /**< or ///< (i.e. one extra /) and are placed directly before the object they document. one extra *) and /// for one-line documentation These comments start with /** for multi-line documentation (i.e. If you need to know more details, read Doxygen documentation.Ĭlasses, function, types and other API components are documented by writing specially marked comments next to them. This page explains basics of writing API documentation using Doxygen and should be sufficient for normal usage in LibreOffice. Which uses specially marked comments written directly in the source code and generates fulltext documentation from them. LibreOffice uses Doxygen for API documentation, 1 Writing API documentation using DoxygenĪll API (Application Programming Interface) should be documented.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |