llvm.org GIT mirror llvm / a2ea78f
Fix an assortment of doxygen comment mistakes found by -Wdocumentation. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@162411 91177308-0d34-0410-b5e6-96231b3b80d8 Ted Kremenek 7 years ago
4 changed file(s) with 16 addition(s) and 14 deletion(s). Raw diff Collapse all Expand all
431431 /// @brief Does status represent a symlink?
432432 ///
433433 /// @param status A file_status previously returned from stat.
434 /// @param result status.type() == symlink_file.
434 /// @returns status.type() == symlink_file.
435435 bool is_symlink(file_status status);
436436
437437 /// @brief Is path a symlink?
460460
461461 /// @brief Is status available?
462462 ///
463 /// @param path Input path.
463 /// @param s Input file status.
464464 /// @results True if status() != status_error.
465465 bool status_known(file_status s);
466466
485485 /// clang-%%-%%-%%-%%-%%.s => /tmp/clang-a0-b1-c2-d3-e4.s
486486 ///
487487 /// @param model Name to base unique path off of.
488 /// @param result_fs Set to the opened file's file descriptor.
488 /// @param result_fd Set to the opened file's file descriptor.
489489 /// @param result_path Set to the opened file's absolute path.
490490 /// @param makeAbsolute If true and @model is not an absolute path, a temp
491491 /// directory will be prepended.
585585
586586 public:
587587 enum mapmode {
588 readonly, //< May only access map via const_data as read only.
589 readwrite, //< May access map via data and modify it. Written to path.
590 priv //< May modify via data, but changes are lost on destruction.
588 readonly, ///< May only access map via const_data as read only.
589 readwrite, ///< May access map via data and modify it. Written to path.
590 priv ///< May modify via data, but changes are lost on destruction.
591591 };
592592
593593 private:
657657 ///
658658 /// @param path Path to file to map.
659659 /// @param file_offset Byte offset in file where mapping should begin.
660 /// @param size_t Byte length of range of the file to map.
660 /// @param size Byte length of range of the file to map.
661661 /// @param map_writable If true, the file will be mapped in r/w such
662662 /// that changes to the mapped buffer will be flushed back
663663 /// to the file. If false, the file will be mapped read-only
271271 /// ignored if the user or system has set the typical environment variable
272272 /// (e.g., TEMP on Windows, TMPDIR on *nix) to specify a temporary directory.
273273 ///
274 /// @param Result Holds the resulting path name.
274 /// @param result Holds the resulting path name.
275275 void system_temp_directory(bool erasedOnReboot, SmallVectorImpl &result);
276276
277277 /// @brief Has root name?
164164
165165 /// Determines if two TimeValue objects represent the same moment in time.
166166 /// @brief True iff *this == that.
167 /// @brief True if this == that.
168167 int operator == (const TimeValue &that) const {
169168 return (this->seconds_ == that.seconds_) &&
170169 (this->nanos_ == that.nanos_);
209209
210210 /// Changes the foreground color of text that will be output from this point
211211 /// forward.
212 /// @param colors ANSI color to use, the special SAVEDCOLOR can be used to
212 /// @param Color ANSI color to use, the special SAVEDCOLOR can be used to
213213 /// change only the bold attribute, and keep colors untouched
214 /// @param bold bold/brighter text, default false
215 /// @param bg if true change the background, default: change foreground
214 /// @param Bold bold/brighter text, default false
215 /// @param BG if true change the background, default: change foreground
216216 /// @returns itself so it can be used within << invocations
217 virtual raw_ostream &changeColor(enum Colors, bool = false, bool = false) {
218 return *this; }
217 virtual raw_ostream &changeColor(enum Colors Color,
218 bool Bold = false,
219 bool BG = false) {
220 return *this;
221 }
219222
220223 /// Resets the colors to terminal defaults. Call this when you are done
221224 /// outputting colored text, or before program exit.