← Back to branch summary

~alexreg/darwindotnet/0.1

« back to all changes in this revision

Viewing changes to Documentation/Content/d3cac186-b06b-4d46-8449-2316cbce6391.aml

  • Committer: Alex Regueiro
  • Date: 2009-02-13 01:07:30 UTC
  • Revision ID: alexreg@gmail.com-20090213010730-3lwp0tiqc4a777t2
Updated XML documentation for DarwinDotNet project.
Upgraded Sandcastle Help File builder project file to v1.8 (now .shfbproj extension).
Restructured Documentation directory (now only Sandcastle source files are included and no built content).

Show diffs side-by-side

added added

removed removed

Lines of Context:
Documentation/Content/d3cac186-b06b-4d46-8449-2316cbce6391.aml
 
1
<?xml version="1.0" encoding="utf-8"?>
 
2
<topic id="d3cac186-b06b-4d46-8449-2316cbce6391" revisionNumber="1">
 
3
  <developerHowToDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
 
4
    <!--
 
5
    <summary>
 
6
      <para>Optional summary abstract</para>
 
7
    </summary>
 
8
    -->
 
9
    <introduction>
 
10
      <para>Required introduction</para>
 
11
    </introduction>
 
12
    <!-- Optional procedures followed by optional code example but must have
 
13
         at least one procedure or code example -->
 
14
    <procedure>
 
15
      <title>Procedure title</title>
 
16
      <steps class="ordered">
 
17
        <step>
 
18
          <content>
 
19
            <para>First step</para>
 
20
          </content>
 
21
        </step>
 
22
        <step>
 
23
          <content>
 
24
            <para>Second step</para>
 
25
          </content>
 
26
        </step>
 
27
      </steps>
 
28
      <!-- <conclusion>Optional conclusion</conclusion> -->
 
29
    </procedure>
 
30
    <!-- <codeExample>Optional code example</codeExample> -->
 
31
    <!-- <buildInstructions>Optional instructions for building a
 
32
         code example.</buildInstructions> -->
 
33
    <!-- <robustProgramming>Optional discussion of error handling and other
 
34
         issues related to writing solid code.</robustProgramming> -->
 
35
    <!-- <security>Optional discussion of security issues.</security> -->
 
36
    <relatedTopics>
 
37
      <!-- One or more of the following:
 
38
           - A local link
 
39
           - An external link
 
40
           - A code entity reference
 
41
 
 
42
      <link xlink:href="Other Topic's ID">Link text</link>
 
43
      <externalLink>
 
44
          <linkText>Link text</linkText>
 
45
          <linkAlternateText>Optional alternate link text</linkAlternateText>
 
46
          <linkUri>URI</linkUri>
 
47
      </externalLink>
 
48
      <codeEntityReference>API member ID</codeEntityReference>
 
49
 
 
50
      Examples:
 
51
 
 
52
      <link xlink:href="00e97994-e9e6-46e0-b420-5be86b2f8278">Some other topic</link>
 
53
 
 
54
      <externalLink>
 
55
          <linkText>SHFB on CodePlex</linkText>
 
56
          <linkAlternateText>Go to CodePlex</linkAlternateText>
 
57
          <linkUri>http://shfb.codeplex.com</linkUri>
 
58
      </externalLink>
 
59
 
 
60
      <codeEntityReference>T:TestDoc.TestClass</codeEntityReference>
 
61
      <codeEntityReference>P:TestDoc.TestClass.SomeProperty</codeEntityReference>
 
62
      <codeEntityReference>M:TestDoc.TestClass.#ctor</codeEntityReference>
 
63
      <codeEntityReference>M:TestDoc.TestClass.#ctor(System.String,System.Int32)</codeEntityReference>
 
64
      <codeEntityReference>M:TestDoc.TestClass.ToString</codeEntityReference>
 
65
      <codeEntityReference>M:TestDoc.TestClass.FirstMethod</codeEntityReference>
 
66
      <codeEntityReference>M:TestDoc.TestClass.SecondMethod(System.Int32,System.String)</codeEntityReference>
 
67
      -->
 
68
    </relatedTopics>
 
69
  </developerHowToDocument>
 
70
</topic>
 
 
b'\\ No newline at end of file'