Print Page | Close Window

[Bug] Outdated comment

Printed From: Codejock Forums
Category: Codejock Products
Forum Name: Docking Pane
Forum Description: Topics Related to Codejock Docking Pane
URL: http://forum.codejock.com/forum_posts.asp?TID=17427
Printed Date: 15 August 2022 at 9:57pm
Software Version: Web Wiz Forums 12.04 - http://www.webwizforums.com


Topic: [Bug] Outdated comment
Posted By: ABuenger
Subject: [Bug] Outdated comment
Date 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



Replies:
Posted By: Oleg
Date 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


Posted By: ABuenger
Date 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



Print Page | Close Window

Forum Software by Web Wiz Forums® version 12.04 - http://www.webwizforums.com
Copyright ©2001-2021 Web Wiz Ltd. - https://www.webwiz.net