Codejock Forums Homepage
Forum Home Forum Home > Codejock Products > Visual C++ MFC > Docking Pane
  New Posts New Posts RSS Feed - [Bug] Outdated comment
  FAQ FAQ  Forum Search   Events   Register Register  Login Login

[Bug] Outdated comment

 Post Reply Post Reply
Author
Message
ABuenger View Drop Down
Newbie
Newbie
Avatar

Joined: 02 February 2006
Status: Offline
Points: 1075
Post Options Post Options   Thanks (0) Thanks(0)   Quote ABuenger Quote  Post ReplyReply Direct Link To This Post Topic: [Bug] Outdated comment
    Posted: 14 October 2010 at 10:39am
    //-----------------------------------------------------------------------
    // Summary:
    //     Call this member to switch the visual theme of the panes.
    // Parameters:
    //     theme - New visual theme. Can be any of the values listed in the Remarks section.
    // Remarks:
    //     theme can be one of the following:
    //     * <b>xtpPaneThemeDefault</b> Enables the default theme.
    //     * <b>xtpPaneThemeVisualStudio2003</b> Enables Visual Studio .NET style theme.
    //     * <b>xtpPaneThemeGrippered</b> Enables Visual Studio 6 style theme.
    //     * <b>xtpPaneThemeOffice2002Visio</b> Enables Visio style theme.
    //     * <b>xtpPaneThemeOffice2003</b> Enables Office 2003 style theme.
    //     * <b>xtpPaneThemeWinNative</b> Enables XP Theme.
    //     * <b>xtpPaneThemeVisualStudio2005Beta1</b> Enables Whidbey theme.
    //-----------------------------------------------------------------------
    void SetTheme(XTPDockingPanePaintTheme theme);

I would replace this with a simple comment:

    // Remarks:
    //     See XTPDockingPanePaintTheme enumeration for available themes.

Codejock support
Back to Top
Oleg View Drop Down
Admin Group
Admin Group


Joined: 21 May 2003
Location: United States
Status: Offline
Points: 11234
Post Options Post Options   Thanks (0) Thanks(0)   Quote Oleg Quote  Post ReplyReply Direct Link To This Post Posted: 14 October 2010 at 1:54pm
Hi,

Developers can have addins installed that show comment when hover over method. It will give them information what enum can be used.
Oleg, Support Team
CODEJOCK SOFTWARE SOLUTIONS
Back to Top
ABuenger View Drop Down
Newbie
Newbie
Avatar

Joined: 02 February 2006
Status: Offline
Points: 1075
Post Options Post Options   Thanks (0) Thanks(0)   Quote ABuenger Quote  Post ReplyReply Direct Link To This Post Posted: 14 October 2010 at 6:37pm
Originally posted by oleg oleg wrote:

Hi,

Developers can have addins installed that show comment when hover over method. It will give them information what enum can be used.


Then you'll always have to update the comment when you add a new theme. There are a lot missing currently.

Developers with an add in like Visual AssistX can quickly go to the declaration of the enum. Also without any addin "Go to definition" will work.

Codejock support
Back to Top
 Post Reply Post Reply
  Share Topic   

Forum Jump Forum Permissions View Drop Down

Forum Software by Web Wiz Forums® version 12.04
Copyright ©2001-2021 Web Wiz Ltd.

This page was generated in 0.172 seconds.