annotate src/VisVim/VsReadMe.txt @ 8952:9b04f9e8d1d4 v7.4.1761

commit https://github.com/vim/vim/commit/8ed43916dbea4ccedcc84d271e292abbf658b9c5 Author: Bram Moolenaar <Bram@vim.org> Date: Thu Apr 21 08:56:12 2016 +0200 patch 7.4.1761 Problem: Coverity complains about ignoring return value. Solution: Add "(void)" to get rid of the warning.
author Christian Brabandt <cb@256bit.org>
date Thu, 21 Apr 2016 09:00:08 +0200
parents 3fc0f57ecb91
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
1 ========================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
2 DEVELOPER STUDIO ADD-IN : VisVim
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
3 ========================================================================
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
4
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
5
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
6 The Add-in Wizard has created this VisVim DLL for you. This DLL not only
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
7 demonstrates the basics of creating a Developer Studio add-in, but it is also
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
8 a starting point for writing your own add-in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
9
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
10 An add-in mainly does two things.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
11 (1) It adds commands to Developer Studio, which can then be tied
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
12 to keystrokes or toolbar buttons by the user or programmatically
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
13 by the add-in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
14 (2) It responds to events fired by Developer Studio.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
15 In both cases, the add-in code has access to the full Developer Studio
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
16 Automation Object Model, and may manipulate those objects to affect the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
17 behavior of Developer Studio.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
18
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
19 This file contains a summary of what you will find in each of the files that
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
20 make up your VisVim DLL.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
21
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
22
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
23 VisVim.h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
24 This is the main header file for the DLL. It declares the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
25 CVisVimApp class.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
26
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
27 VisVim.cpp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
28 This is the main DLL source file. It contains the class CVisVimApp.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
29 It also contains the OLE entry points required of inproc servers.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
30
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
31 VisVim.odl
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
32 This file contains the Object Description Language source code for the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
33 type library of your DLL.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
34
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
35 VisVim.rc
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
36 This is a listing of all of the Microsoft Windows resources that the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
37 program uses. It includes the sample toolbar bitmap that is stored
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
38 in the RES subdirectory. This file can be directly edited in Microsoft
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
39 Developer Studio.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
40
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
41 res\VisVim.rc2
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
42 This file contains resources that are not edited by Microsoft
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
43 Developer Studio. You should place all resources not
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
44 editable by the resource editor in this file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
45
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
46 VisVim.def
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
47 This file contains information about the DLL that must be
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
48 provided to run with Microsoft Windows. It defines parameters
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
49 such as the name and description of the DLL. It also exports
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
50 functions from the DLL.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
51
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
52 VisVim.clw
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
53 This file contains information used by ClassWizard to edit existing
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
54 classes or add new classes. ClassWizard also uses this file to store
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
55 information needed to create and edit message maps and dialog data
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
56 maps and to create prototype member functions.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
57
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
58 /////////////////////////////////////////////////////////////////////////////
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
59 Add-in-specific files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
60
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
61 DSAddIn.cpp, DSAddIn.h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
62 These files contain the CDSAddIn class, which implements the
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
63 IDSAddIn interface. This interface contains handlers
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
64 for connecting and disconnecting the add-in.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
65
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
66 Commands.cpp, Commands.h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
67 These files contain the CCommands class, which implements your
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
68 command dispatch interface. This interface contains one method
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
69 for each command you add to Developer Studio.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
70 These files also contain stub implementations of handlers for all events
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
71 fired by the Developer Studio Application object.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
72
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
73 OleAut.cpp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
74 These files contain a general OLE automation class used to communicate
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
75 with vim.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
76
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
77 Reg.cpp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
78 These files contain functions to access the registry.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
79
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
80
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
81 /////////////////////////////////////////////////////////////////////////////
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
82 Other standard files:
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
83
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
84 StdAfx.h, StdAfx.cpp
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
85 These files are used to build a precompiled header (PCH) file
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
86 named VisVim.pch and a precompiled types file named StdAfx.obj.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
87
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
88 Resource.h
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
89 This is the standard header file, which defines new resource IDs.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
90 Microsoft Developer Studio reads and updates this file.
3fc0f57ecb91 updated for version 7.0001
vimboss
parents:
diff changeset
91