// The Nova Project by Ken Beckett. // Copyright (C) 2007-2012 Inevitable Software, all rights reserved. // Released under the Common Development and Distribution License, CDDL-1.0: http://opensource.org/licenses/cddl1.php using System; using Nova.Rendering; namespace Nova.CodeDOM { /// <summary> /// Represents plain-text user documentation of code. /// </summary> /// <remarks> /// This class is used to mix portions of plain-text with other embedded documentation comment objects, such as <see cref="DocSee"/> or <see cref="DocCode"/>. /// If a documentation comment object contains only plain-text, it will store it as a simple string instead of using this object. /// </remarks> public class DocText : DocComment { #region /* CONSTRUCTORS */ /// <summary> /// Create a <see cref="DocText"/>. /// </summary> public DocText(string text) : base(text) { } #endregion #region /* PROPERTIES */ /// <summary> /// The text content of the object. /// </summary> public override string Text { get { return (string)_content; } } #endregion #region /* METHODS */ /// <summary> /// Add the specified text to the documentation comment. /// </summary> public override void Add(string text) { _content += text; } /// <summary> /// Throws an exception if called. /// </summary> public override void Add(DocComment docComment) { throw new Exception("Can't add DocComment objects to DocText objects (add them both to a parent DocComment instead)."); } #endregion #region /* FORMATTING */ /// <summary> /// True if the code object defaults to starting on a new line. /// </summary> public override bool IsFirstOnLineDefault { get { return false; } } #endregion #region /* RENDERING */ protected override void AsTextContent(CodeWriter writer, RenderFlags flags) { writer.EscapeUnicode = false; AsTextText(writer, (string)_content, flags); writer.EscapeUnicode = true; } public static void AsTextText(CodeWriter writer, string text, RenderFlags flags) { string[] lines = text.Split('\n'); for (int i = 0; i < lines.Length; ++i) { if (i > 0) AsTextDocNewLines(writer, 1); if (lines[i].Length > 0) { // Turn on translation of '<', '&', and '>' for content if (!flags.HasFlag(RenderFlags.NoTranslations)) writer.InDocCommentContent = true; writer.Write(lines[i]); writer.InDocCommentContent = false; } } } #endregion } }
By viewing downloads associated with this article you agree to the Terms of use and the article's licence.
If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.
This article, along with any associated source code and files, is licensed under The Common Development and Distribution License (CDDL)
The Next Version of Android - Some of What's Coming
Submit an article or tip
Post your Blog
