Skip to content

Commit 2e46587

Browse files
committed
Add directives.
1 parent 5c8233d commit 2e46587

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

docs/source/server.rst

+26-15
Original file line numberDiff line numberDiff line change
@@ -101,25 +101,36 @@ are not in the type library.
101101

102102
The meaning of the attributes:
103103

104-
``_reg_threading_`` must be set to "Both", "Free", or "Apartment".
105-
It specifies the apartment model in which the server runs.
104+
.. py:attribute:: _reg_threading_
106105
107-
``_reg_progid_`` and ``_reg_novers_progid`` are optional short
108-
names that can later be used to specify your object, instead of
109-
the CLSID in type library. Typically the type library name plus
110-
the coclass name plus a version number are combined to form the
111-
progid, and the type library name plus the coclass name are
112-
combined to form the version independend progid.
106+
Must be set to "Both", "Free", or "Apartment".
107+
It specifies the apartment model in which the server runs.
113108

114-
``_reg_desc_`` is the (optional) name of the coclass.
109+
.. py:attribute:: _reg_progid_
110+
.. py:attribute:: _reg_novers_progid_
115111
116-
The ``_reg_clsctx_`` constant specifies in which contexts the com
117-
server can operate.
112+
(optional) The short names that can later be used to specify
113+
your object, instead of the CLSID in type library. Typically
114+
the type library name plus the coclass name plus a version
115+
number are combined to form the progid, and the type library
116+
name plus the coclass name are combined to form the version
117+
independend progid.
118118

119-
The optional ``_regcls_`` constant is only used for com objects
120-
that run in their own process, see the MSDN docs for more info.
121-
In |comtypes|, several REGCLS values are defined in the
122-
``comtyper.server.localserver`` module.
119+
.. py:attribute:: _reg_desc_
120+
121+
(optional) The name of the coclass.
122+
123+
.. py:attribute:: _reg_clsctx_
124+
125+
The constant specifies in which contexts the COM server can
126+
operate.
127+
128+
.. py:attribute:: _regcls_
129+
130+
(optional) The constant is only used for com objects that
131+
run in their own process, see the MSDN docs for more info.
132+
In |comtypes|, several REGCLS values are defined in the
133+
``comtyper.server.localserver`` module.
123134

124135
You do not yet implement any methods on the class, because basic
125136
functionality is already present.

0 commit comments

Comments
 (0)