Skip to content

Standardize See also sections #831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 8, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion docs/assembler/masm/dot-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,3 @@ end
## See also

[Directives Reference](../../assembler/masm/directives-reference.md)<br/>

Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,9 @@ In general, the rules for allocating and releasing memory allocated for `BSTR`s

[!code-cpp[NVC_ATLMFC_Utilities#196](../atl-mfc-shared/codesnippet/cpp/allocating-and-releasing-memory-for-a-bstr_5.cpp)]

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)<br/>
[CStringT::AllocSysString](../atl-mfc-shared/reference/cstringt-class.md#allocsysstring)<br/>
[SysAllocString](/windows/desktop/api/oleauto/nf-oleauto-sysallocstring)<br/>
[SysFreeString](/windows/desktop/api/oleauto/nf-oleauto-sysfreestring)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/atl-mfc-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ This section provides conceptual and task-based topics to help you program using
[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)<br/>
Describes how to manage string data in applications.

## See Also
## See also

[ATL/MFC Shared Classes](../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/avoidance-of-heap-contention.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Multiple threads could be running using this same thread procedure but since eac

For a more complicated thread procedure, it may be convenient to store a pointer to the thread's string manager in a thread local storage (TLS) slot. This allows other functions called by the thread procedure to access the thread's string manager.

## See Also
## See also

[Memory Management with CStringT](../atl-mfc-shared/memory-management-with-cstringt.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/basic-cstring-operations.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,9 @@ wcout << (const wchar_t*) cs << endl;

Without the cast, `cs` is treated as a `void*` and `wcout` prints the address of the object. This behavior is caused by subtle interactions between template argument deduction and overload resolution which are in themselves correct and conformant with the C++ standard.

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)<br/>
[CStringT Class](../atl-mfc-shared/reference/cstringt-class.md)<br/>
[Template Specialization](../cpp/template-specialization-cpp.md)<br/>
[How to: Convert Between Various String Types](../text/how-to-convert-between-various-string-types.md)

Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@ Whenever the fixed buffer is not in use, `CFixedStringMgr` ensures that it is in

**Header:** cstringt.h

## See Also
## See also

[Memory Management with CStringT](../atl-mfc-shared/memory-management-with-cstringt.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/cstring-argument-passing.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ Typically you can return `CString` objects from functions because `CString` obje

[!code-cpp[NVC_ATLMFC_Utilities#198](../atl-mfc-shared/codesnippet/cpp/cstring-argument-passing_2.cpp)]

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/cstring-exception-cleanup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ In previous versions of MFC, it was important that you clean up [CString](../atl

Under the C++ exception handling mechanism that MFC now uses, you do not have to worry about cleanup after an exception. For a description of how C++ "unwinds" the stack after an exception is caught, see [the try, catch, and throw statements](../cpp/try-throw-and-catch-statements-cpp.md). Even if you use the MFC **TRY**/**CATCH** macros instead of the C++ keywords **try** and **catch**, MFC uses the C++ exception mechanism underneath, so you still do not need to clean up explicitly.

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)<br/>
[Exception Handling](../mfc/exception-handling-in-mfc.md)

Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ You can also specify a formal parameter as a constant string reference (that is,

For most function results, you can simply return a `CString` object by value.

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)<br/>
[CString Argument Passing](../atl-mfc-shared/cstring-argument-passing.md)
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/cstring-semantics.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ You can assign one `CString` object to another. However, when you modify one of

Note in the example that the two `CString` objects are considered "equal" because they represent the same character string. The `CString` class overloads the equality operator (`==`) to compare two `CString` objects based on their value (contents) rather than their identity (address).

## See Also
## See also

[Strings (ATL/MFC)](../atl-mfc-shared/strings-atl-mfc.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/current-time-automation-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ The following procedure shows how to create a `COleDateTime` object and initiali

[!code-cpp[NVC_ATLMFC_Utilities#177](../atl-mfc-shared/codesnippet/cpp/current-time-automation-classes_1.cpp)]

## See Also
## See also

[Date and Time: Automation Support](../atl-mfc-shared/date-and-time-automation-support.md)
2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/date-and-time-automation-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,6 @@ The CRT correctly calculates a difference of 23 hours. `COleDateTimeSpan` calcul

[!code-cpp[NVC_ATLMFC_Utilities#176](../atl-mfc-shared/codesnippet/cpp/date-and-time-automation-support_1.cpp)]

## See Also
## See also

[Date and Time](../atl-mfc-shared/date-and-time.md)
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/date-and-time-database-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ As of version 4.0, MFC database programming uses the [COleDateTime](../atl-mfc-s

- [Automation support of date and time programming](../atl-mfc-shared/date-and-time-automation-support.md)

## See Also
## See also

[Date and Time](../atl-mfc-shared/date-and-time.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/date-and-time-systemtime-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ You most likely will not use `CTime` `FILETIME` initialization directly. If you

- [Automation support of date and time programming](../atl-mfc-shared/date-and-time-automation-support.md)

## See Also
## See also

[Date and Time](../atl-mfc-shared/date-and-time.md)
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/date-and-time.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ MFC supports several different ways of working with dates and times. These inclu

- [Date and Time: Database Support](../atl-mfc-shared/date-and-time-database-support.md)

## See Also
## See also

[Concepts](../mfc/mfc-concepts.md)<br/>
[General MFC Topics](../mfc/general-mfc-topics.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/date-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ The following points should be noted when working with these date and time forma

More information on issues related to the DATE and `COleDateTime` types can be found under [COleDateTime Class](../atl-mfc-shared/reference/coledatetime-class.md) and [Date and Time: Automation Support](../atl-mfc-shared/date-and-time-automation-support.md).

## See Also
## See also

[Date and Time](../atl-mfc-shared/date-and-time.md)<br/>
[COleDateTime Class](../atl-mfc-shared/reference/coledatetime-class.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/elapsed-time-automation-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ This procedure shows how to calculate the difference between two `CTime` objects

[!code-cpp[NVC_ATLMFC_Utilities#178](../atl-mfc-shared/codesnippet/cpp/elapsed-time-automation-classes_1.cpp)]

## See Also
## See also

[Date and Time: Automation Support](../atl-mfc-shared/date-and-time-automation-support.md)
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,3 @@ The following procedure shows how to calculate the difference between two `CTime
[!code-cpp[NVC_ATLMFC_Utilities#174](../atl-mfc-shared/codesnippet/cpp/elapsed-time-general-purpose-classes_1.cpp)]

Once you have calculated `elapsedTime`, you can use the member functions of `CTimeSpan` to extract the components of the elapsed-time value.

Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,7 @@ There are several caveats:

[CStringT Class](../atl-mfc-shared/reference/cstringt-class.md)

## See Also
## See also

[Using CStringT](../atl-mfc-shared/using-cstringt.md)<br/>
[Using CString](../atl-mfc-shared/using-cstring.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/formatting-time-automation-classes.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ For more information, see class [COleVariant](../mfc/reference/colevariant-class

- [Working with SYSTEMTIME](../atl-mfc-shared/date-and-time-systemtime-support.md)

## See Also
## See also

[Date and Time: Automation Support](../atl-mfc-shared/date-and-time-automation-support.md)

Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ Use the `Format` member function from either the [CTime](../atl-mfc-shared/refer
- [Working with SYSTEMTIME](../atl-mfc-shared/date-and-time-systemtime-support.md)

- [Automation support of date and time programming](../atl-mfc-shared/date-and-time-automation-support.md)

Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ The `CStringData` structure comprises four fields:

When allocating a `CStringData` structure, you must set this field to reflect the type of sharing that is allowed for the buffer. For most implementations, set this value to one. This allows the usual copy-on-write sharing behavior. However, if your string manager does not support sharing the string buffer, set this field to a locked state. This forces `CStringT` to only use this buffer for the instance of `CStringT` that allocated it.

## See Also
## See also

[Memory Management with CStringT](../atl-mfc-shared/memory-management-with-cstringt.md)

Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ To use this private string manager to manage memory for a `CString` variable, pa

[!code-cpp[NVC_ATLMFC_Utilities#181](../atl-mfc-shared/codesnippet/cpp/implementation-of-a-custom-string-manager-basic-method_2.cpp)]

## See Also
## See also

[Memory Management with CStringT](../atl-mfc-shared/memory-management-with-cstringt.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/memory-management-with-cstringt.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Class [CStringT](../atl-mfc-shared/reference/cstringt-class.md) is a template cl

- [CFixedStringT: An Example of a Custom String Manager](../atl-mfc-shared/cfixedstringt-example-of-a-custom-string-manager.md)

## See Also
## See also

[CustomString sample](../visual-cpp-samples.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/reference/cfiletime-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ static const ULONGLONG Week = Day* 7;

See the example for [CFileTime::Millisecond](#millisecond).

## See Also
## See also

[FILETIME](/windows/desktop/api/minwinbase/ns-minwinbase-filetime)<br/>
[CFileTimeSpan Class](../../atl-mfc-shared/reference/cfiletimespan-class.md)<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/reference/cfiletimespan-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,7 @@ void SetTimeSpan(LONGLONG nSpan) throw();
*nSpan*<br/>
The new value for the time span in milliseconds.

## See Also
## See also

[FILETIME](/windows/desktop/api/minwinbase/ns-minwinbase-filetime)<br/>
[CFileTime Class](../../atl-mfc-shared/reference/cfiletime-class.md)<br/>
Expand Down
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/cfixedstringt-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,8 @@ An existing `CFixedStringT` to be copied into this `CFixedStringT` object.

You should be aware that memory exceptions may occur whenever you use the assignment operator because new storage is often allocated to hold the resulting `CFixedStringT` object.

## See Also
## See also

[CStringT Class](../../atl-mfc-shared/reference/cstringt-class.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/reference/cimage-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -1600,7 +1600,7 @@ BOOL TransparentBlt(CImage* pSrcImage, CImage* pDstImage,
}
```

## See Also
## See also

[MMXSwarm Sample](../../visual-cpp-samples.md)<br/>
[SimpleImage Sample](../../visual-cpp-samples.md)<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ The following table lists the classes shared between MFC and ATL.
|[CTimeSpan](../../atl-mfc-shared/reference/ctimespan-class.md)|An amount of time, which is internally stored as the number of seconds in the time span.|atltime.h|
|[IAtlStringMgr](../../atl-mfc-shared/reference/iatlstringmgr-class.md)|Represents the interface to a `CStringT` memory manager.|atlsimpstr.h|

## See Also
## See also

[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/coledatetime-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -1188,11 +1188,10 @@ For more information about the bounds for `COleDateTime` values, see the article

See the example for [SetDate](#setdate).

## See Also
## See also

[COleVariant Class](../../mfc/reference/colevariant-class.md)<br/>
[CTime Class](../../atl-mfc-shared/reference/ctime-class.md)<br/>
[CTimeSpan Class](../../atl-mfc-shared/reference/ctimespan-class.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/coledatetimespan-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -723,11 +723,10 @@ For a brief description of these status values, see the following list:

[!code-cpp[NVC_ATLMFC_Utilities#22](../../atl-mfc-shared/codesnippet/cpp/coledatetimespan-class_13.cpp)]

## See Also
## See also

[COleDateTime Class](../../atl-mfc-shared/reference/coledatetime-class.md)<br/>
[CTime Class](../../atl-mfc-shared/reference/ctime-class.md)<br/>
[CTimeSpan Class](../../atl-mfc-shared/reference/ctimespan-class.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/cpoint-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,11 +327,10 @@ Use the unary operator to negate a point. For example, using the unary operator

[!code-cpp[NVC_ATLMFC_Utilities#34](../../atl-mfc-shared/codesnippet/cpp/cpoint-class_7.cpp)]

## See Also
## See also

[MFC Sample MDI](../../visual-cpp-samples.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[POINT Structure](/windows/desktop/api/windef/ns-windef-tagpoint)<br/>
[CRect Class](../../atl-mfc-shared/reference/crect-class.md)<br/>
[CSize Class](../../atl-mfc-shared/reference/csize-class.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/crect-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -1463,9 +1463,8 @@ The width can be negative.
ASSERT(nWid == 60);
```

## See Also
## See also

[CPoint Class](cpoint-class.md)<br/>
[CSize Class](csize-class.md)<br/>
[RECT](/windows/desktop/api/windef/ns-windef-tagrect)

4 changes: 2 additions & 2 deletions docs/atl-mfc-shared/reference/csimplestringt-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,7 @@ Destroys a `CSimpleStringT` object.

Call this method to destroy the `CSimpleStringT` object.

## See Also
## See also

[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/csize-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,10 +211,9 @@ The fourth operator, the unary minus, changes the sign of the `CSize` value. See

[!code-cpp[NVC_ATLMFC_Utilities#103](../../atl-mfc-shared/codesnippet/cpp/csize-class_7.cpp)]

## See Also
## See also

[MFC Sample MDI](../../visual-cpp-samples.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[CRect Class](../../atl-mfc-shared/reference/crect-class.md)<br/>
[CPoint Class](../../atl-mfc-shared/reference/cpoint-class.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/cstrbuft-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,7 @@ typedef CSimpleStringT<TCharType> StringType;

`TCharType` is the character type used to specialize the class template.

## See Also
## See also

[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/cstringdata-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,7 @@ Call this function to unlock the character buffer of the string data object. Onc

Locking and unlocking is used when the developer must ensure that the string data not be shared. A good example of locking is demonstrated by the [LockBuffer](../../atl-mfc-shared/reference/csimplestringt-class.md#lockbuffer) and [UnlockBuffer](../../atl-mfc-shared/reference/csimplestringt-class.md#unlockbuffer) methods of `CSimpleStringT`.

## See Also
## See also

[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/cstringt-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -1646,9 +1646,8 @@ The `CStringT& TrimRight()` version requires no parameters. It trims any trailin

[!code-cpp[NVC_ATLMFC_Utilities#138](../../atl-mfc-shared/codesnippet/cpp/cstringt-class_42.cpp)]

## See Also
## See also

[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)<br/>
[CSimpleStringT Class](../../atl-mfc-shared/reference/csimplestringt-class.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/reference/ctime-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -623,7 +623,7 @@ The `CArchive` object that you want to update.

The updated `CArchive` object.

## See Also
## See also

[asctime_s, _wasctime_s](../../c-runtime-library/reference/asctime-s-wasctime-s.md)<br/>
[_ftime_s, _ftime32_s, _ftime64_s](../../c-runtime-library/reference/ftime-s-ftime32-s-ftime64-s.md)<br/>
Expand Down
3 changes: 1 addition & 2 deletions docs/atl-mfc-shared/reference/ctimespan-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ The `CArchive` object that you want to update.

The updated `CArchive` object.

## See Also
## See also

[asctime, _wasctime](../../c-runtime-library/reference/asctime-wasctime.md)<br/>
[_ftime, _ftime32, _ftime64](../../c-runtime-library/reference/ftime-ftime32-ftime64.md)<br/>
Expand All @@ -391,4 +391,3 @@ The updated `CArchive` object.
[time, _time32, _time64](../../c-runtime-library/reference/time-time32-time64.md)<br/>
[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)

2 changes: 1 addition & 1 deletion docs/atl-mfc-shared/reference/iatlstringmgr-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ Call [IAtlStringMgr::Free](#free) to free the memory allocated by this method.
> [!NOTE]
> For usage examples, see [Memory Management and CStringT](../../atl-mfc-shared/memory-management-with-cstringt.md).

## See Also
## See also

[Hierarchy Chart](../../mfc/hierarchy-chart.md)<br/>
[ATL/MFC Shared Classes](../../atl-mfc-shared/atl-mfc-shared-classes.md)
Loading