Skip to content

Commit f495112

Browse files
authored
Update Overview.md
updated minor formatting and typo fixes
1 parent c23fec4 commit f495112

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

Docs/Introduction/Data Models/Overview.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,69 @@
1-
# CodeFactory DataModels
2-
The primary strength of CodeFactory is its ability to generate real time data models directly from your project/solution artifacts within the Visual Studio environment.
3-
This ability makes it possible to do design time automation when delivering software. In this section we will provide a brief overview of the data models that are generated dynamically by the CodeFactory platform. These data models are used throughout the automation process.
1+
# CodeFactory Data Models
2+
The primary strength of CodeFactory is its ability to generate real time data models directly from your project/solution artifacts within the Visual Studio IDE.
3+
This ability makes it possible to do design-time automation when delivering software. In this section we will provide a brief overview of the data models that are generated dynamically by the CodeFactory platform. These data models are used throughout the automation process.
44

55
## Data Models
6-
All data models are plain old CLR objects or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since a change to the underlying data model requires a complete regeneration of the data model from the visual studio environment to make sure you have the latest version of all data. For example, making a change to a C# class object would force CodeFactory to regenerate a data model of that file/class object.
6+
All data models are "plain old CLR objects" or POCO's for short. Each data model is implemented as an immutable data class. This approach is used since a change to the underlying data model requires a complete regeneration of the data model from the Visual Studio environment to make sure you have the latest version of all data. For example, making a change to a C# class object would force CodeFactory to regenerate a data model of that file/class object.
77

88
Data model generation is either triggered during the execution of a new automation process, or from various CodeFactory API calls that will request new copies of data models.
99

1010
## Solution Explorer Models (Project System)
1111
The following models are directly generated off the legacy and new project systems that are hosted by Visual Studio.
12-
The overview of each data model is designed to provide an overview of capabilties. The examples here are not complete and only show partial functionality for the purpose of explanation. Please see our help docs for the full description if each data model.
12+
The overview of each data model is designed to provide an overview of capabilties. The examples here are not complete and only reflect partial functionality for the purpose of explanation. Please see our help docs for the full description of each data model.
1313

1414
### Solution
15-
Data model that represents the loaded solution. This provides the location of the solution as well as access to the projects in the solution.
15+
Data model that represents the loaded solution. This provides the location of the solution as well as access to the projects within the solution.
1616

1717
### Solution Folder
18-
Data model that represents a virtual folder that is at scope of the solution level. This provides acess to the name of the folder and the children that are hosted in this folder.
18+
Data model that represents a virtual folder that is at scope of the solution level. This provides acess to the name of the folder and the children objects which are hosted within this folder.
1919

2020
### Project
21-
Data model that represents a loaded project that is managed in the solution. this provides access to the project location and name, and access to all children objects hosted in the project.
21+
Data model that represents a loaded project that is managed in the solution. This provides access to the project location and name, and access to all children objects hosted in the project.
2222

2323
### Project Reference
24-
Data model that represents a reference to a project hosted in the solution. This provides the name of the reference and the target artifact that is being referenced.
24+
Data model that represents a reference to a project hosted within the solution. This provides the name of the reference and the target artifact that is being referenced.
2525

2626
### Project Folder
27-
The project folder model represents a folder under a target project. This will contain the path and name of the folder and the list of child objects that are managed under this project folder.
27+
Project folder model represents a folder under a target project. This will contain the path and name of the folder and the list of child objects which are managed under this project folder.
2828

2929
### Document
30-
Model that represents a file that is hosted in a project, project folder, or solution folder. This will contain the path and the name of the file. As well as access to the full contents in the document itself.
30+
Document model represents a file which is hosted within a project, project folder, or solution folder. This will contain the path and the name of the file, as well as access to the full contents of the document itself.
3131

3232
### C# Source Document
33-
The C# source document project system access as well as full access to the C# source code that is hosted in the document itself.
33+
C# Source Document provides project system access, as well as full access to the C# source code which is hosted within the document itself.
3434

3535
## C# Language Models - (Source Code)
36-
CodeFactory has access to the C# language compiler and can dynamically generate data models the represent the C# based source code.
36+
CodeFactory has access to the C# language compiler and can dynamically generate data models that represent the C#-based source code.
3737
CodeFactory provides direct access all the way down to member and type level data.
38-
In addition, will give you direct access to the raw source code at the target object level.
39-
The following data models are generated whenever you are accessing from source code files, or from directly referenced assemblies.
40-
The overview of each data model is designed to provide an example of capabilties and does not list every single data element or function. Please see our help docs for the full description if each data model.
38+
In addition, CodeFactory will provide direct access to the raw source code at the target object level.
39+
The following data models are auto-generated whenever accessing source code files or directly referenced assemblies.
40+
The overview of each data model is designed to provide an example of capabilties and does not list every single data element or function. Please see our help docs for the full description of each data model.
4141

42-
### Soure Code
43-
The source code data model provides access to all elements that were compiled from the source code document. This includes the following.
42+
### Source Code
43+
The Source Code model provides access to all elements that were compiled from the source code document. This includes the following:
4444
- Namespaces
4545
- Using Statements
4646
- Classes
4747
- Interfaces
4848
- Structures
4949

5050
### Using Statement
51-
Using statement provides information on target namespaces to use in the code base. This includes the following.
51+
Using Statement model provides information on targeted namespaces to use in the code base. This includes the following:
5252
- Namespace
5353
- Alias
5454

5555
### Namespace Statement
56-
Namespace model provides the target namespace that other c# code elements are contained in.
56+
Namespace model provides the target namespace that other C# code elements are contained in.
5757

5858
### Attribute
59-
Attribute provides a data model of the type of the attribute and the parameters that have been assigned to the attribute. This includes the following
59+
Attribute provides a data model of the type of attribute and parameters which have been assigned to the attribute. This includes the following:
6060
- Name
6161
- Namespace
6262
- Named Parameters
6363
- Constructor Parameters
6464

6565
### Attribute Parameter
66-
Data model that provides the data for a target parameter on an attribute. This includes the following.
66+
Data model that provides the data for a target parameter on an attribute. This includes the following:
6767
- Name (Optional)
6868
- Parameter values
6969

@@ -74,7 +74,7 @@ Data model that provides a target value that is assigned to an attribute paramet
7474
Enum data model provides the definition of an enumeration and the target values of the enumeration.
7575

7676
### Class
77-
The Class data model provides data on a target class hosted in source code. This will include the following.
77+
The Class data model provides data on a target class hosted in source code. This will include the following:
7878
- Attributes
7979
- Name
8080
- Namespace
@@ -84,7 +84,7 @@ The Class data model provides data on a target class hosted in source code. This
8484
- Members (Events, Fields, Methods, Properties)
8585

8686
### Interface
87-
The Interface data model provides data on the target interface definition in source code. This will include the following.
87+
The Interface data model provides data on the target interface definition in source code. This will include the following:
8888
- Attributes
8989
- Name
9090
- Namespace
@@ -95,7 +95,7 @@ The Interface data model provides data on the target interface definition in sou
9595

9696

9797
### Structure
98-
The structure data model provides data on the target structure definition in source code. This will include the following.
98+
The Structure data model provides data on the target structure definition in source code. This will include the following:
9999
- Attributes
100100
- Name
101101
- Namespace
@@ -105,14 +105,14 @@ The structure data model provides data on the target structure definition in sou
105105
- Members (Events, Fields, Methods, Properties)
106106

107107
### Delegate
108-
The delegate model provides data on the definition of a delegate in source code. This will include the following.
108+
The Delegate model provides data on the definition of a delegate in source code. This will include the following:
109109
- Name
110110
- Namespace
111111
- Parameters
112112
- Return type
113113

114114
### Event
115-
The event data model provides data on the definition of an event in source code. This will include the following.
115+
The Event data model provides data on the definition of an event in source code. This will include the following:
116116
- Attributes
117117
- Name
118118
- Type
@@ -121,7 +121,7 @@ The event data model provides data on the definition of an event in source code.
121121
- EventHandlerMethod Definition
122122

123123
### Field
124-
The field data model provides data on the definition of a field in source code. This will include the following.
124+
The Field data model provides data on the definition of a field in source code. This will include the following:
125125

126126
- Attributes
127127
- Name
@@ -131,7 +131,7 @@ The field data model provides data on the definition of a field in source code.
131131
- Assigned value
132132

133133
### Method
134-
The method data model provides data on the definition of a method in source code. This will include the following.
134+
The Method data model provides data on the definition of a method in source code. This will include the following:
135135
- Attributes
136136
- Name
137137
- Security Scope
@@ -141,26 +141,26 @@ The method data model provides data on the definition of a method in source code
141141
- Method Type
142142

143143
### Property
144-
The property data model provides data on the definition of a property in source code. This will include the following.
144+
The Property data model provides data on the definition of a property in source code. This will include the following:
145145
- Attributes
146146
- Name
147147
- Type
148-
- Propery Security
148+
- Property Security
149149
- Keywords
150150
- Has Get
151151
- Get Security
152152
- Has Set
153153
- Set Security
154154

155155
### Parameter
156-
The Parameter data model provides data on the definition of a parameter in a method or a delegate. This will include the following.
156+
The Parameter data model provides data on the definition of a parameter in a method or a delegate. This will include the following:
157157
- Attributes
158158
- Name
159159
- Keywords
160160
- Default value
161161

162162
### Type
163-
The type datamodel provides information about a type that is used in all the above source code definition. This will include the following.
163+
The Type data model provides information about a type that is used in all the above source code definitions. This will include the following:
164164
- Name
165165
- Namespace
166166
- IsValueType

0 commit comments

Comments
 (0)