Uploaded image for project: 'Couchbase .NET client library'
  1. Couchbase .NET client library
  2. NCBC-251

Certain method summaries are not linked properly in docs

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Minor
    • Resolution: Won't Fix
    • Affects Version/s: 1.2.4
    • Fix Version/s: 1.2.7
    • Component/s: docs
    • Labels:
      None

      Description

      I haven't checked all of them, but many links off of this page do not go anywhere: http://www.couchbase.com/docs/couchbase-sdk-net-1.2/api-reference-summary.html

      For example, all the getwithlock links do not have documentation behind them.

      No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

        Hide
        kzeller kzeller added a comment -

        Aaron investigated this for several hours and the XML for .net is set up completely correctly using the old API system.

        This will be something we will need to resolve (cross-ref links) either in new system or using standard docs generator (javadoc, rdoc, doxygen) for .Net.

        Show
        kzeller kzeller added a comment - Aaron investigated this for several hours and the XML for .net is set up completely correctly using the old API system. This will be something we will need to resolve (cross-ref links) either in new system or using standard docs generator (javadoc, rdoc, doxygen) for .Net.
        Hide
        perry Perry Krug added a comment -

        Thanks for looking into this. Can we just confirm that we were looking at the same spots?

        I've attached a screenshot of me hovering over one of these links and in the bottom you will see that it resolves to "http://www.couchbase.com/docs/couchbase-sdk-net-1.2/api-reference-summary.html" which is the same page that we're on.

        This is the same case for:
        object.Cas(storemode, key, value, casunique)
        object.ExecuteCas(storemode, key, value, casunique)
        object.ExecuteGetWithLock-expiresat(key [, getl-expiry ])
        object.ExecuteUnlock(key [, getl-expiry ])
        object.GetWithLock(key [, getl-expiry ])
        object.GetWithLock-expiresat(key [, getl-expiry ])
        object.new CouchbaseClient([ url ] [, username ] [, password ])
        object.Unlock(key [, getl-expiry ])

        Show
        perry Perry Krug added a comment - Thanks for looking into this. Can we just confirm that we were looking at the same spots? I've attached a screenshot of me hovering over one of these links and in the bottom you will see that it resolves to "http://www.couchbase.com/docs/couchbase-sdk-net-1.2/api-reference-summary.html" which is the same page that we're on. This is the same case for: object.Cas(storemode, key, value, casunique) object.ExecuteCas(storemode, key, value, casunique) object.ExecuteGetWithLock-expiresat(key [, getl-expiry ] ) object.ExecuteUnlock(key [, getl-expiry ] ) object.GetWithLock(key [, getl-expiry ] ) object.GetWithLock-expiresat(key [, getl-expiry ] ) object.new CouchbaseClient([ url ] [, username ] [, password ] ) object.Unlock(key [, getl-expiry ] )
        Hide
        kzeller kzeller added a comment -

        Yes this is Chapter 3. .Net Method Summary which strangely enough converts into proper jump links within PDF for items like ExecuteCas and Cas.

        So xmllint is passing this as clean XML, as well as our proprietary make tasks to building PDF and HTML. When we look at the XML file where all of this lives, memcached.xml it appears as if the XML nesting is correct. Keep in mind that use of these tags, attributes, and so on where never really documented anywhere or explained by anyone to people like John or myself. While it may be valid XML and valid proprietary XML, there may be an issue at the actual proprietary parser level.

        It has been decided that we will not invest any more resources on the old XML system that this is a part of. If you have a major concern about this, you can reopen this ticket and assign to Dipti with the request for budget and the right technical consultant to fix it.

        Show
        kzeller kzeller added a comment - Yes this is Chapter 3. .Net Method Summary which strangely enough converts into proper jump links within PDF for items like ExecuteCas and Cas. So xmllint is passing this as clean XML, as well as our proprietary make tasks to building PDF and HTML. When we look at the XML file where all of this lives, memcached.xml it appears as if the XML nesting is correct. Keep in mind that use of these tags, attributes, and so on where never really documented anywhere or explained by anyone to people like John or myself. While it may be valid XML and valid proprietary XML, there may be an issue at the actual proprietary parser level. It has been decided that we will not invest any more resources on the old XML system that this is a part of. If you have a major concern about this, you can reopen this ticket and assign to Dipti with the request for budget and the right technical consultant to fix it.

          People

          • Assignee:
            kzeller kzeller
            Reporter:
            perry Perry Krug
          • Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes